Check an API's Documentation Quality
Chris Arsenault
Find undocumented operations and missing responses in an OpenAPI spec before integrating.
Input
Output fields
Sign up on Apify or log in
The OpenAPI / Swagger Spec Audit Actor is ready to run with the inputs already set for "Check an API's Documentation Quality". Sign up or log in and you'll land in Apify Console with a copy of this exact task.
Start the "Check an API's Documentation Quality" task
The OpenAPI / Swagger Spec Audit Actor will start running based on the input automatically. You can also change all the input fields, like spec url or inline spec, to match your specific use case.
Receive the "Check an API's Documentation Quality" output
Monitor the progress in real time. You will be notified as soon as your dataset is complete and ready for review. Each result includes data such as method, path, operationid, and more.
Integrate into your workflow
The final output is delivered in JSON, CSV, or Excel format, ready to be plugged into your workflow. You can also run the "Check an API's Documentation Quality" task via API.
