Niveau 29 - Vue d'ensemble et documentation de l'API (OpenAPI)
Pour l'API de votre projet, elle doit être documentée en entier. Cela vous aidera grandement en tant qu'équipe et facilitera vos tests manuels.
Il est difficile d'avoir une vue d'ensemble de l'API: les différentes URL accessibles, les paramètres acceptés, les méthodes HTTP, la structure générale, etc.
Pour avoir une meilleure vue d'ensemble, il est possible de documenter l'API selon le standard OpenAPI.
The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to HTTP APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined, a consumer can understand and interact with the remote service with a minimal amount of implementation logic.
An OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases.
Documenter l'API adéquatement permet à quiconque voulant l'utiliser d'avoir accès aux spécifications de façon standardisée et même d'effectuer facilement des requêtes de test. De plus, le standard OpenAPI prévoit la création d'un site généré automatiquement permettant de facilement visualiser l'API et ses spécifications.
Dans ce niveau
Vous aurez l'occasion de générer automatiquement une page représentant la documentation de votre API. Cette documentation sera même interactive, vous permettant d'effectuer des requêtes tests.
Plus précisément:
- Installer la librairie NestJS d'OpenAPI
- Configurer NestJS pour utiliser OpenAPI
- Accéder à la page de documentation
- Documenter l'API