Introduction of OpenAPI specification for REST API

OpenAPI Specification (formerly Swagger Specification) is an API description format for REST APIs. An OpenAPI file allows you to describe your entire API. For more information about the OpenAPI, please refer to the official website of Swagger. AlchemyJ enables you to generate the specification by a single click.

The specification can be accessed through an URL. It would be started up along with your API. The UI of the generated specification would be as shown below.

On the page, you can find the overall information of the API, such as the title, version and license. In addition, you can find the details of every endpoint, such as the HTTP method, path, description, parameters, example value, default value, corresponding models being used in the API and so on. Besides the specification, you can even have a try of the API on the page immediately.