API Concepts: Difference between revisions
Jump to navigation
Jump to search
| Line 26: | Line 26: | ||
Documentation can be auto-generated from an API definition, or can be generated from an existing API at runtime (see [[Swagger Inflector]], [[Swagger Inspector]]). | Documentation can be auto-generated from an API definition, or can be generated from an existing API at runtime (see [[Swagger Inflector]], [[Swagger Inspector]]). | ||
<FONT color=darkgray>TO PROCESS: | |||
* Best Practices in API Documentation https://swagger.io/resources/articles/best-practices-in-api-documentation/ | |||
* Documenting Your Existing APIs: API Documentation Made Easy with OpenAPI & Swagger https://swagger.io/resources/articles/documenting-apis-with-swagger/ | |||
* API Documentation with the OpenAPI Specification & Swagger Tools https://smartbear.com/resources/webinars/api-documentation-openapi-swagger/ | |||
</FONT> | |||
=API Testing= | =API Testing= | ||
Revision as of 21:50, 28 January 2019
Internal
API Design
API Design or API Modeling.
TO PROCESS:
- Best Practices in API Design: https://swagger.io/resources/articles/best-practices-in-api-design/
- Building and Enforcing API Standards at Scale with Swagger https://smartbear.com/resources/webinars/building-api-standards/
- Will Your API Design Process Scale? https://swagger.io/blog/api-design/will-your-api-design-process-scale/
API Development
One of the artifacts of API development could be a client SDK. Tools like Swagger Codegen provide the means to generate SDK right from the API definition.
TO PROCESS:
- How to Build an API from the Ground Up: https://swagger.io/resources/articles/how-to-build-an-api-from-the-ground-up/
- Definition-Driven API development https://swagger.io/resources/webinars/definition-driven-api-development-how-oas-swagger/
- Why You Should Create an API Definition: https://swagger.io/blog/api-development/why-you-should-create-an-api-definition/
API Documentation
Documentation can be auto-generated from an API definition, or can be generated from an existing API at runtime (see Swagger Inflector, Swagger Inspector).
TO PROCESS:
- Best Practices in API Documentation https://swagger.io/resources/articles/best-practices-in-api-documentation/
- Documenting Your Existing APIs: API Documentation Made Easy with OpenAPI & Swagger https://swagger.io/resources/articles/documenting-apis-with-swagger/
- API Documentation with the OpenAPI Specification & Swagger Tools https://smartbear.com/resources/webinars/api-documentation-openapi-swagger/
API Testing
API Mocking and Virtualization
API development can become cumbersome as the number of dependencies on internal and external services grows. A technique to deal with that is to mock API dependencies, and interact with them before the actual service is built.