Write OpenAPI endpoint documentation in ChatGPT
Turn known parameters, status codes, and example responses into an OpenAPI draft and flag missing endpoint constraints.
中文Install in ChatGPT
A ChatGPT workspace with skill creation enabled. Paste the fictional material below as text.
- In a ChatGPT workspace with skill creation enabled, open Plugins → Skills → Create → Create with editor.
- Create a skill in the editor and adapt the text-only `api-documentation` workflow from the pinned GitHub source into its instructions.
- Save the skill, then type @ in a new chat to select it and try the example.
Example task
Write a documentation example for the Garden beds endpoint.
api="Garden beds"; operation="GET /beds"; limitType="integer"; limitMaximum=20; successStatus=200; successBody=[{"id":"bed-a"}]; invalidStatus=400; invalidBody={"error":"invalid limit"}What to check
The draft includes `GET /beds; limit: integer; maximum: 20; codes: 200/400` and documents the supplied response schemas and examples. Mark authentication and rate limits as open.
Original SKILL.md on GitHub · Updated
Frequently asked question
How can ChatGPT document OpenAPI parameters and error responses?
Organize the endpoint by method and path. Document parameter types, success and error codes, and response shapes. Check against the supplied examples and flag missing endpoint constraints.