Skip to main content

API Endpoint Documentation

Document an API endpoint with request/response examples

Template Fields

API NametextRequired

e.g., User Management API, Payment API

HTTP MethodselectRequired
GETPOSTPUTPATCHDELETE
Endpoint PathtextRequired

e.g., /api/v1/users, /api/orders/{id}

What This Endpoint DoestextRequired

e.g., Creates a new user, Retrieves order details

Parameters/Request BodymultilineRequired

List all parameters: name, type, required/optional, description

Response FieldsmultilineRequired

Key fields in the response

Authenticationselect
Bearer TokenAPI KeyOAuth 2.0No AuthSession Cookie
Use This Template

Related Templates

Bug Report

Write a clear, actionable bug report that developers can act on immediately

README Generator

Create a professional README.md for any project or repository

API Documentation

Pro

Comprehensive API documentation with examples and best practices

System Design Document

Pro

Detailed system architecture and design documentation