API ouverte
La spécification OpenAPI (anciennement Swagger Specification ) est une norme pour décrire les interfaces de programmation (API) compatibles REST . La spécification est financée par l' OpenAPI Initiative . L'initiative poursuit la vision de fournir un format de description ouvert et neutre vis-à-vis du fabricant pour les services API dans l'intérêt d'un monde en réseau. Le projet est soutenu par la Linux Foundation .
l'histoire
L'API Open Specification a commencé dans le cadre du projet de logiciel Swagger , un open source - Cadre pour HTTP - Web Services . En 2016, il est devenu un projet autonome géré par l' OpenAPI Initiative , dont les membres comprennent des sociétés telles qu'Atlassian , Google , IBM , Microsoft , PayPal et SAP .
La version actuelle de la spécification OpenAPI est la 3.1.0.
Outils
Swagger fournit une collection d' outils open source pour développer des API conformes à la spécification OpenAPI :
- Swagger Editor prend en charge la création de la définition de l'API
- Swagger Codegen génère serveur moignons et SDK client
- L'interface utilisateur Swagger génère de la documentation
Il existe également des outils payants :
- SwaggerHub pour la collaboration
- SwaggerHub Enterprise pour les entreprises, disponible dans le cloud ou sur site
- Inspecteur Swagger à des fins de test
- APITree convertit les spécifications OpenAPI 2.0 et 3.0 en une documentation API lisible par l'homme qui peut être gérée et partagée gratuitement dans le cloud via un HUB.
Il existe également des extensions pour prendre en charge OpenAPI pour divers environnements de développement.
Littérature
- Stefan Sauter People, Michael Heiß, Christopher Köster : Entrée dans OpenAPI v3 : REST grandit . Dans : Magazine des développeurs . Non. 1 , 2018, p. ? ( entwickler.de [consulté le 24 février 2020] Version en ligne gratuite ).
- Manuel Ottlik : Document des API REST selon le standard OpenAPI . Dans : c't . Non. 5 , 2020, p. 136-139 ( heise.de [consulté le 22 février 2020]).
liens web
- openapis.org - Site officiel de l'Initiative OpenAPI
- OpenAPI sur GitHub
Exemples:
- petstore.swagger.io - serveur fictif pour démontrer OpenAPI
- hub.apitree.com - Répertoire public de projets OpenAPI avec des exemples interactifs
- github.com/… - Documents OpenAPI en .NET
Preuve individuelle
- ↑ spécification OpenAPI sur GitHub. Consulté le 30 décembre 2019 .
- ↑ A propos de l'Initiative OpenAPI. Consulté le 30 décembre 2019 .
- ↑ Projets de la Fondation Linux. Consulté le 30 décembre 2019 .
- ↑ Les membres de l'Initiative OpenAPI. Consulté le 30 décembre 2019 .
- ↑ Publications de la spécification OpenAPI. Consulté le 24 septembre 2020 .
- ↑ OpenAPI outils open source. Consulté le 30 décembre 2019 .
- ↑ éditeur OpenAPI pour le code Visual Studio. Consulté le 30 décembre 2019 .
- ↑ outils OpenAPI pour Eclipse. Consulté le 30 décembre 2019 .
