Apprenez Swagger et la spécification Open API
La spécification Open API (souvent appelée “Swagger”) est actuellement le moyen le plus populaire de créer des définitions d’API RESTful. Avec ces définitions, vous pouvez créer une documentation sophistiquée et générée automatiquement, générer des SDK dans plusieurs langues et effectuer des tests automatisés. Swagger est un ensemble d’outils open source qui utilisent ces fichiers de définition de spécifications Open API .
Cette classe est destinée aux personnes de l’industrie du logiciel qui sont assez techniques, mais ne sont pas des développeurs de logiciels : par exemple, chefs de projet, chefs de produit API et rédacteurs techniques. Cela suppose que vous compreniez REST et JSON, mais c’est à peu près tout. Il est destiné aux personnes qui découvrent l’Open API Specification and Swagger, plutôt que pour les experts. Il couvre :
- Ce que vous pouvez faire avec Open API Spécifications (OAS) fichiers
- Le format de fichier YAML
- Comment créer un fichier OAS
- Comment spécifier la sécurité
- Comment ajouter de la documentation
- Comment écrire un fichier OAS en JSON
- Alternatives à Swagger et OAS
Cette classe ne pas couverture :
- Comment configurer Swagger sur votre propre serveur
- Comment modifier le code open source de Swagger
En plus des vidéos, ce cours contient 8 exercices pratiques qui vous guident pas à pas dans la création d’un fichier de définition d’API, y compris un projet final dans lequel vous créez un fichier à partir de zéro en utilisant la documentation d’une API commerciale réelle. Il contient également un document contenant des ressources pour en savoir plus sur l’OAS, Swagger et les alternatives.
En plus des conférences vidéo, prévoyez de passer au moins 4 heures à faire les exercices. Ces exercices sont essentiels pour comprendre Swagger et OAS.
Important : le cours utilise OAS 2. Une version plus récente, OAS 3, commence à être davantage utilisée. , mais de nombreuses entreprises utilisent encore OAS 2. Il y a une conférence qui vous montre les différences entre OAS 2 et OAS 3.
Introduction
Covers:
- API Definitions
- What is a REST API?
- Prerequisites
- Swagger
- The Open API Initiative
- Course Overview
Covers:
- What’s an API Definition File?
- Anatomy of an API Request
- What’s in an API Definition File?
- Getting Information to create an API Definition File
- How YAML is used with the Open API Specification
- What is YAML?
- Rules of YAML
Answer these questions about the YAML format.
Open API Specification
- What applies to the entire API
- What applies to a simple request
- Path, method, query and parameters, headers
- Using the Swagger editor
Answer these questions about the Open API Specification format.
Covers:
- What is a schema?
- References
- Request bodies
- Response bodies
Answer these questions about schemas.
Covers:
- Security
- Error Conditions
- Content types (JSON, JPEG, etc.)
- Operation IDs
Answer these questions about the Open API Specification
Covers:
- What autogenerated documentation is
- How autogenerated documentation looks
- How to add description tags
Tools and Alternatives
- Swagger editor
- Swagger CodeGen
- Swagger UI (Autogenerated documentation)
- Core tooling
- SwaggerHub
- Why JSON over YAML?
- How to construct JSON OAS files
- Alternatives to Swagger
- DapperDox, Swagger UI variants, ReadMe.io, StopLight.io
- Alternatives to OAS
- RAML, API Blueprint
- Resources
Links to resources on Swagger and alternatives.
