Skip to content

Latest commit

 

History

History
45 lines (25 loc) · 1.63 KB

nAPIDocumentation.md

File metadata and controls

45 lines (25 loc) · 1.63 KB
since author tags
2017-07-14
emchateau
api, documentation

Documentation des APIs

Normes et standards

OpenAPI Specification

OpenAPI Specification

The OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface description for HTTP APIs, which allows both humans and computers to discover and understand the capabilities of a service without requiring access to source code, additional documentation, or inspection of network traffic. When properly defined via OpenAPI, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interface descriptions have done for lower-level programming, the OpenAPI Specification removes guesswork in calling a service.

Lincoln, a React component for rendering OpenAPI definitions.

json:api

json:api

A specification for building APIs in JSON

Outils

Swagger

Swagger places API specifications such as OpenAPI, AsyncAPI, and JSON Schema at the core of its architecture, which are crucial for guiding teams through the entire lifecycle of API design and documentation. This strategic focus ensures that our suite, including open source tools and SwaggerHub, delivers unparalleled efficiency and a seamless user experience.

https://swagger.io

API doc JS

API blueprint