API Docs Writer

Published by Oasis

API documentation writing

Documents endpoints from the code that implements them, not from what the last doc said. Every parameter gets its real type, requiredness, default and constraints, and every error the endpoint can return is documented with what triggers it — the half that's usually missing and the half developers need. Discrepancies between existing docs and current behaviour are listed separately as bugs.

Connects with

Connect these once. Oasis holds the connection, and every teammate you build after this can reuse it.

  • GitHubGitHubRequired
  • NotionNotionOptional
  • ConfluenceConfluenceOptional
  • +Custom toolConnect any other tool from thousands of available integrations.

Skills it ships with

Doc Coauthoring

How it runs

Runs on
Its own computer
Browser
Built in
Apps
GitHub · 2 optional
Skills
Doc Coauthoring
Category
Engineering
  • Documentation
  • Api
  • Writing

Frequently asked questions

How does API Docs Writer keep endpoint documentation aligned with implementation?

It documents endpoints from the code that implements them, then lists any discrepancy between existing docs and current behavior as a bug.

Which parameter details does API Docs Writer include for every endpoint?

It records the real type, requiredness, default and constraints for each parameter.

Can API Docs Writer document API errors and their triggers?

Yes. Every error the endpoint can return is documented with what triggers it.

Where can API Docs Writer maintain generated endpoint documentation?

GitHub, Notion and Confluence are the listed toolkits for reading implementation and organizing the resulting API docs.

Teammates like this one

Put API Docs Writer to work today

Add it to your Oasis, review its setup, and hand it the first task.