How to test an API
The final step in the API creation process is to test it to ensure that it works as intended. Testing can be done using another Frends Process, the application, or solution that is planned to consume the API.
Once the API has been tested and deployed to production, it is available for consumption. The API usage is monitored, and the API is maintained. Eventually, the API reaches the end of its lifecycle and is ramped down.
Monitoring an integration Process is covered in a separate training module.
API - Key concepts
Here are some key concepts related to APIs:
Term or Abbreviation | Definition |
API | An Application Programming Interface is a connection between computers or between computer programs. |
API Endpoint | A point where an API, the code that allows two software programs to communicate with each other, connects with the software program. |
Swagger | An Interface Description Language for describing RESTful APIs expressed using JSON. Swagger is used with a set of open-source software tools to design, build, document, and use RESTful web services. |
OpenAPI Specification | An API description format for REST APIs, formerly known as the Swagger Specification. |
API Authentication Method | Validates the identity of the client attempting to make a connection by using a selected authentication protocol. |
API Key | A unique identifier used to authenticate a user, developer, or calling program to an API. |
Ruleset | Groups all the access rules used for selected API Keys. |
API Access Policy | Controls access to API resources. |
API Base Path | APIs have a base URL to which endpoint paths are appended. The base URL is defined by the root level of the API specification. |
The next article is Introduction to Understanding the Frends API List View