Description
The Web API Framework allows you to build a REST API in DataFlex with the help of drag and drop features within the DataFlex Studio. You can expose fields in your API similarly to how you expose data in a DataFlex application, using the entry_item command.
Swagger UI
The WebApi Framework generates documentation for your REST API in the format of the OpenApi specification. The OpenAPI specification can then be used in tools like Swagger and Postman to easily test your API and/or share it with a consumer of your REST API.
The library comes with a web control that you can put into your web applications. This web control turns the OpenAPI specification into a readable and easy to understand user interface.
Swagger UI is capable of describing the following aspects of your REST API:
- Available endpoints.
- What format data format is supported by the server (XML/JSON).
- The data the client is expected to send along with his/her request.
- The data the client can expect in the response.
- Status codes.
- Available filters (query parameters).
- What security scheme is used (BasicAuth, JWT Bearer).
Screenshots
