/ 01
Structure without the clutter.
Organize endpoints into stashes and optional API groups. Give every route a place that makes sense.
The API documentation workspace
Bring your APIs
into the light.
A home for the details that matter. Organize your endpoints, document with precision, and give your team a clearer way to build.
Considered down to the last parameter.Commerce API
Products
The catalog, clearly documented.
Endpoints3
GET/v1/productsList products
POST/v1/productsCreate a product
GET/v1/products/:idGet a product
A shared source of clarity.
FIG. 01 — A little structure. A lot of clarity.
/ 02
Every detail, in focus.
Parameters, authentication, schemas, and responses. The full picture, clearly documented.
/ 03
The same page. Finally.
Share a project invitation link. Give teammates the right access to view or edit.
Inside your Lumen workspace
A place for every route.
Context for every detail.
Lumen brings your API documentation into one shared workspace, from the project structure to the fields in a response.
- Projects
- A dedicated home for each app or service.
- API stashes
- Keep related routes together, like auth, users, or payments.
- Optional API groups
- Add another level of organization inside a stash. Leave other endpoints ungrouped.
One project. A clear structure.EXAMPLE
SnipfulProject
Better AuthAPI stash
Email Authentication
POSTSign Up/auth/sign-up
POSTSign In/auth/sign-in
Session Management
GETCurrent Session/auth/session
Use groups when they help. Your stash works just as well without them.
Give your next API a clear home.
Create a project, add a stash, and document your first endpoint.