This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

APIs

1: API design
2: API documentation
3: API implementation

APIs make communication easy.

1 - API design

Requirements

Map CRUD operations to HTTP methods.
Enforce idempotency.
Follow a naming style guide.

Examples

CRUD:
- Swagger best practices
Idempotency:
- Stripe idempotency
Style guide:
- Google naming conventions

See also

API integrations

2 - API documentation

Requirements

Generate documentation from the source code.
Adhere to a specification.
Provide examples.

Examples

Generated documentation:
- NSwag
Specification:
- OpenAPI Specification (OAS)
Examples:
- GitHub authentication

See also

System documentation

3 - API implementation

Requirements

Define APIs.
Consume APIs.
Handle errors.

Examples

Definition:
- Spring server
Consumption:
- Node.js client
Errors:
- OpenFeign timeout handling

See also

API integrations