API Specification

Your project defines contracts at two different architectural levels:

🌐 HTTP API Contract

External Contract — how the outside world talks to your system.

🧱 Internal Code Contract

Internal Contract — how developers structure and maintain the code inside it.

The HTTP API Contract defines what the system promises externally.
The Internal Code Contract defines how that promise is implemented.

Assignment Requirement

You are required to author and maintain both contracts for your project:

HTTP API Contract (OpenAPI/Swagger): document your REST endpoints, request/response formats, error responses, and authentication.
Internal Code Contract (Javadoc): document your core classes and methods (purpose, parameters, returns, exceptions, and usage).

If your implementation changes, your contracts must be updated. Outdated documentation will be treated as incomplete.

This section collects concise guidance and tooling recommendations for producing a high-quality OpenAPI/Swagger specification for your project and wiring it into the preinstalled Redocusaurus integration.

For generators, code-first workflows, or more advanced examples (Javadoc, OpenAPI generators), see the Best Practices page linked above.