Document your API endpoints in a structured spreadsheet that developers can reference and share. This template lists every endpoint with its HTTP method, path, description, required parameters, and an example response summary. It is useful for teams that want a quick reference table alongside their full documentation site, or for sharing API specs with external partners who do not have access to your internal docs. The spreadsheet format makes it easy to sort endpoints by method or search for a specific path. When generated via the API, you can pull endpoint definitions from your OpenAPI spec or code annotations and produce an always-current reference sheet. Share the link with third-party integrators, include it in onboarding docs for new engineers, or embed it in your internal wiki as a living reference.
| Method | Endpoint | Description | Auth Required | Parameters | Response |
|---|---|---|---|---|---|
| POST | /api/v1/sheets | Create a new spreadsheet | Yes | title, columns, rows | { id, url, created_at } |
| GET | /api/v1/sheets/:id | Retrieve spreadsheet data | Yes | id (path) | { id, title, columns, rows } |
| PUT | /api/v1/sheets/:id | Replace spreadsheet data | Yes | id (path), data | { updated: true } |
| DELETE | /api/v1/sheets/:id | Delete a spreadsheet | Yes | id (path) | { deleted: true } |
| GET | /api/v1/download/:id | Export as XLSX/PDF/CSV/DOCX | No | id (path), format (query) | Binary file download |
Generate this api documentation programmatically with a single POST request. The API returns a shareable URL that anyone can open in the browser.
curl -X POST https://openofficeai.com/api/v1/sheets \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"title": "My API Documentation",
"sheets": [{ "rows": [["Method","Endpoint","Description","Auth Required","Parameters","Response"],["POST","/api/v1/sheets","Create a new spreadsheet","Yes","title, columns, rows","{ id, url, created_at }"],["GET","/api/v1/sheets/:id","Retrieve spreadsheet data","Yes","id (path)","{ id, title, columns, rows }"]] }]
}'Returns { "id": "...", "url": "...", "created_at": "..." }. See the full API docs for formatting, formulas, and export options.
This template comes with 6 columns designed for a standard api documentation workflow. Each column can be renamed, reordered, or extended through the API or the browser editor.
The HTTP method: GET, POST, PATCH, PUT, or DELETE.
The URL path for this API endpoint.
A brief explanation of what this endpoint does.
Whether the endpoint requires an API key or bearer token.
The input parameters accepted by this endpoint (path, query, or body).
A summary of the response payload structure.
This template is a starting point. Here are specific ways to adapt it to your workflow:
Add a "Rate Limit" column to document the request limits per endpoint, so integrators know their constraints upfront.
Include a "Version Added" column to track when each endpoint was introduced, useful for maintaining backward compatibility notes.
Add an "Example Request" column with a short curl command or JSON body that developers can copy and test immediately.
Yes. Parse your openapi.json or openapi.yaml file to extract endpoints, methods, descriptions, and parameters. Then format the data into the template structure and send it to the API. Run this script on every deploy to keep the reference table in sync with your actual API.
Create the spreadsheet with view-only sharing enabled. Send the link to your partners — they can view the full endpoint reference in their browser without creating an account. If you update the spreadsheet later, the same link reflects the latest version automatically.
Yes. Cells support plain text of any length, so you can include short code snippets or curl examples in the Parameters or Response columns. For longer examples, consider linking to a separate documentation page from within the cell text.
Keep a structured changelog that records every release, what changed, and who shipped it. This templ...
Compare features across products, plans, or competitors in a clear matrix format. This template puts...
Keep your team aligned with a project tracker that shows every task, its owner, status, and deadline...
Sign up for free and start building spreadsheets in seconds — from the browser or via the API.