This is a repository that contains the swagger and the Open API specifications for APIs. This project was created to build APIs from the swagger (OpenAPI) definition.
In order to make modifications to the swaggers you will need to install the editor, to do so, you have two different options:
- You can download the de Swagger UI and Editor from this repository then create a http-server using node:
npm install -g http-server- You can download the following VSCode extention
This is an API that provides different operations to manage a Book such as:
- Getting all books
- Getting an specific book
- Insert a Book
Open API defines an Application Interface (API) using the following structure:
In this section we can describe the general functionality of the API and provide some contact information about the developers, versioning, terms of services, and license.
In this section we can add information about the API hosting implementation such as the URLs for Production, Development and Testing environments.
This section describes the security implemented in the API such as cookies, authorization and authentication to use this resource.
This section has the endpoints and the different operations that this API is able to perform.
These two sections have additional information about the API like external links for further reference.
This has a set of reusable objects that can be used in different parts of the API.
- Domains provide object reusability across APIs
- API management capabilities such as security, versioning, and source control integration
- API definition and documentation hosting
- API mocking and virtualization
- Swagger Editor enhancement
- Promotes consistent API design across organizations and teams
- Eases collaboration amongs API developers
- Reduces time and effort required to design APIs
- Supports parallel development via contract-first approach