× This site is under continuous improvement. Please help us by providing comments here.

#3 Improve API Documentation by following Swagger (OpenAPI) Specifications

Swagger is a simple yet powerful representation of your RESTful API. With the largest ecosystem of API tooling on the planet, thousands of developers are supporting Swagger in almost every modern programming language and deployment environment. With a Swagger-enabled API, you get interactive documentation, client SDK generation and discoverability.

  • OPENAPI Specification: Swagger™ is a project used to describe and document RESTful APIs. The Swagger specification defines a set of files required to describe such an API.
  • Project Open Data Metadata Schema: This section contains guidance to support the use of the Project Open Data metadata to list agency datasets and application programming interfaces (APIs) as hosted at agency.gov/data.

Leave a comment

Your email address will not be published. Required fields are marked *