Method defining routes to methods: good practices
Summary
Definition of routes orpathsmust be consistent with the resources or entities to which the method refers.
Certain good practices for considering in defining routes.
A review
Before proceeding, let's look at what parts of an endpoint or url. For example:
Definition of language
Method route
Parameters on the route
- "api" is the API query subdomain.
- "company.com" is the domain of your account.
- "Daily indicators" is the name of the API. Remember that the API name would be the item you define when creating the API.
- "v1" is the API version. Review the article on versions of APIs.
- "dolar" is the name of the API method.
- ".json" is the format of consultation to the method. Review the article on output formats.
- What follows the question mark "?" are the parameters to be sent, such as auth_key or others required by the method.
Definition of language
Define a language to use for your APIs and methods. We recommend using English if it is your primary language, but you can also use English. What is relevant in this case is to be consistent, the same language should always be used for APIs, methods, attributes, dictionaries, etc.
Method route
When creating a method, you should define your route.
- Use plural nouns, not verbs.
- Avoid using singular nouns.
- Use the same routes for different types of requests.
- Do not use accents, spaces or special characters in the URL.
- If you want to separate words use the average guide.
Correct examples
Get list of documents in .json format:
Get list of documents in .json format:
Obtain documents by identifier in .json format:
Create documents
Incorrect examples
Singular nouns are not recommended:
Verbs in the URL
Parameters on the route
If required, you can add the data view parameters on the method path.
By default, the method inherits the parameters of its associated view. For example:
But it is also possible to add a parmeter on the method path. To do this, you must enter the route to the method on behalf of the key parameter.
For example:
- /users/{id}
In this case, the API consultation would have the following structure:
Related Articles
Create APIs methods
Summary In the article Create and manage APIs versions The first necessary steps to create APIs were shown. Methods define the action to be taken on a particular esource. As a first step you should select the option of Add Methodin the API. Add ...Try a method
Summary The developer portal allows you to test reading methods (GETs) on the same portal. Test method Enter an API in the APIs Catalog on the portal's homepage. Then select a method and click on the buttonTest method. Select the implementation which ...Method define response formats for methods
Summary Output formats allow you to define one or more response formats in your API methods. Output formats can be multiple in JSON format, although it can also expose the data in CSV and XML. Configure formats When creating a method you should ...Configure context variables at method parameters
Summary Context variables allow you to associate values assigned to the account, users and applications to APIs parameters values. By setting up the API method you can relate its parameters to context variables. When a request is made to the method, ...Configure APIs and Methods Privacy
Summary You can define the privacy of your APIs and methods to grant access only to users you want, or revoke accesses when you require it. Privacy rules You can set up the visibility of APIs and methods, i.e. whether they would be public or private. ...