Describe your API once and get a readable reference page. Enter the base URL, how callers sign in, then up to five endpoints with their parameters, an example request body and an example response. The tool writes the docs in Markdown or HTML and builds a curl command for each endpoint so people can try it straight away.
The first reader of your docs wants to make one successful call. Put the base URL, the sign-in method and a working example near the top, so a developer can copy a request, paste it into a terminal and see a response within a couple of minutes.
After that, readers look things up. Each endpoint needs a method and path, a sentence on what it does, a table of parameters and a sample response. Keeping every endpoint in the same layout lets people find the part they need by scanning rather than reading.
State the type and whether each parameter is required, and say what happens when it is left out. If a value has a limited set of choices, list them. If a field has a default, write the default, since this saves a surprising number of support questions.
Errors deserve their own section. List the status code, the meaning in plain words and what the caller should do next. A table of three or four common errors helps more than a long paragraph, and it gives you a place to add new ones as the API grows.
Documentation goes stale the moment it is separate from the code. Store the Markdown in the same repository as the API and change it in the same pull request as the endpoint, so a reviewer can see both together.
Test your own examples. Run each curl command against a staging server now and then, and fix any that no longer work. A broken example in the docs costs the reader far more time than a missing sentence.
The method, the base URL joined to the path, a header for your chosen authentication (with a placeholder for the secret) and, for POST, PUT and PATCH, a JSON content header and the example body. GET and DELETE requests do not carry a body.
No. The page builds the document in your browser from what you type. Never paste real keys or tokens into the examples. Use placeholders such as YOUR_API_KEY.
Generate one document for each group of five and join the Markdown, or put the first five here and keep adding to the file in your own editor. The format is plain text, so combining parts is easy.
Markdown is best for READMEs and docs sites that already render it. HTML is a plain set of headings, tables and code blocks you can paste into any page. The HTML escapes special characters, so examples display exactly as typed.
No. It produces a human-readable reference page, not a machine-readable specification. If you need generated client code, write an OpenAPI file as well and use this page for the readable overview.
Related: JSON formatter, FAQ generator, Robots.txt generator.
Start for free or see all free tools. We.Inc is free to start, with no card needed. AI building is on paid plans from $20 a month.
We.Inc is an AI-powered website builder you can resell under your own brand. Launch a branded client dashboard, bill on Stripe Connect, and deliver AI-generated websites in minutes. White-label plans start at $99 a month for 25 client sites, with a 7-day free trial and no per-site fees.