Transforming API Development - ChatGPT for OpenAPI Specifications

#api #genai #chatgpt #openapi #swagger #prompting
API documentation is crucial for managing and sharing APIs easily.

The OpenAPI Specification is like a language for describing web APIs. It's usually written in files using either JSON or YAML formats. These files contain important information about an API, like what it does and how to use it.

However, making these files can be challenging and time-consuming. That's where ChatGPT comes in.

ChatGPT uses its language skills to make things easier. You can explain your API in plain language, and ChatGPT will turn it into one of those structured files.

Share the API specification and test it using Swagger UI:
You can use the local Swagger Editor or online Swagger UI to design and define API specification

Install and run your locally following the instructions; you can even use the docker container.

Access Swagger Editor in your local
Copy and paste the YAML file content to the editor; you can review and test the APIs

Another option to share the API is through Confluence; the Swagger UI can be integrated into Confluence through the Swagger Plugin, and the UI can be embedded into the Confluence page and shared with different teams.

Enable one of the Open API Integration plugins from the confluence marketplace; I am going to use "Open API Documentation for Confluence" that supports both JSON and YAML (you can use the free trial version to test)

Now, add the plugin inside the Confluence document. You can embed the OpenAPI YAML or JSON specification from remote systems or directly paste it into the plugin. Now that the Swagger UI is embedded into the confluence page, the API can be reviewed and tested, and the confluence page can be shared with different teams.

Also, Open API specifications can be uploaded to tools/platforms that support Open API specifications, e.g., postman; most of the API gateway supports Open API specifications.