I’ve used tools like Stoplight.io in the past to create draft API first specifications, and while I’m enjoying Apidog as a way to create a mock API, I don’t see any way to add overview information that would normally go in the info section of the OpenAPI spec, things like a general description of the API, the contact details, license or tags. Am I missing a feature or do I have to export, edit the JSON manually and re-import?
Thanks for the feedback.
Perhaps you can try the following two methods.
- You can find the “New” button , click on it and select the “Markdown document” option to start the new document creation process.
2.Please fill in the description field in the API info.
If they do not work, please provide more information to help me understand your needs.
I can see how that can help expand the documentation but as Apaidog is building an openapi contract in the background it would be nice if the UI allowed me to edit (and display) the header info from the contract. When I export the contract it’s very barren, missing the description, contact and license details… This means we will need to use a different tool to edit the contract and what we produce in Apidog will be out of sync with that “post export edit” version
Also, tags are really handy for grouping API endpoints for testing and 3rd party documentation rendering…
Apologize for taking so long to reply to you. Based on your use case, you can put the overall description of the project in Project-BasicSettings-Intro. By this way, when exporting the openapi document, it will also be exported to info.description.Additionally, the tags export is working fine as shown in the screenshot.
