API Concepts

Internal

• API
• Amazon API Gateway Concepts
• REST and Hypermedia

Overview

A REST API is made up of resources and methods.

REST and Hypermedia Concepts

Resource, Method, Request, Response

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/

Top-Down Approach vs. Bottom-Up Approach

The top-down API design and development approach is also known as "schema-first" or "definition-driven" approach. TO PROCESS: https://howtodoinjava.com/swagger2/code-generation-for-rest-api/

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:

• https://www.infoq.com/presentations/doc-restful-api
• 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

TO PROCESS:

• https://swagger.io/solutions/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.

TO PROCESS:

• https://swagger.io/solutions/mocking-and-virtualization/

API Governance

TO PROCESS:

• https://swagger.io/solutions/governance-and-standardization/

API Monitoring

TO PROCESS:

• https://swagger.io/solutions/api-monitoring/

OpenAPI

OpenAPI