This is an old revision of the document!
Table of Contents
API
The API design tooling.
Declaration
Spring HATEOAS
The https://spring.io/projects/spring-hateoas is the API which is capable to generate a clean HATEOAS API our of some Data Access Objects (DAOs) / Resources. The requirement is - the ability to map the backend to DAOs.
By exporting the full API
http://localhost:8095/v2/api-docs?group=full-api
and importing it via the Swagger Editor in a browser: http://editor.swagger.io
Select Paste JSON… from the File menu.
It can be imported to SWAGGER form
Swagger / OpenAPI 3.0
Creating the API describtion in SWAGGER, using the API might be the first step to create an API. It is for sure a good medium to communicate the APIs. https://editor.swagger.io/
Swagger Tools for SWAGGER / Open API3.0 (OAS3)
The Swagger tools are now separated from the API Specification. The API Specification is in Open API 3.0. The tools still support Open API 3.0
Swagger UI | Visualization of the SWAGGER API |
Swagger Editor | Creation of the SWAGGER API |
Graphql API
Get the data by describing it https://graphql.org/
Operation
SAM Framework
The AWS SAM framework is capable of deploying the serverless infrastructure on AWS