CtrlK
BlogDocsLog inGet started
Tessl Logo

tessl-labs/api-documentation

API documentation with OpenAPI/Swagger — endpoint descriptions, request/response

66

1.06x
Quality

57%

Does it follow best practices?

Impact

100%

1.06x

Average score across 3 eval scenarios

SecuritybySnyk

Passed

No known issues

Overview
Quality
Evals
Security
Files

Evaluation results

100%

18%

Inventory Service API

FastAPI documentation patterns

Criteria
Without context
With context

Decorator summary param

100%

100%

Decorator response_description

0%

100%

Handler docstrings

100%

100%

Pydantic Field descriptions

100%

100%

Error responses declared

0%

100%

Required vs optional fields

100%

100%

Path parameter documented

100%

100%

Query parameters present

100%

100%

Query param typing

100%

100%

All four endpoints implemented

100%

100%

requirements.txt present

100%

100%

README mentions /docs

100%

100%

100%

Booking API for a Venue Rental Platform

Express Swagger documentation

Criteria
Without context
With context

swagger-jsdoc dependency

100%

100%

swagger-ui-express dependency

100%

100%

@openapi JSDoc annotations

100%

100%

swagger-ui-express mounted

100%

100%

Error responses in annotations

100%

100%

Request body schema in annotations

100%

100%

Required fields in schema

100%

100%

Query parameter documented

100%

100%

Path parameter documented

100%

100%

README mentions /api-docs

100%

100%

All four routes implemented

100%

100%

100%

Document the Feedback Collection API

Markdown API documentation

Criteria
Without context
With context

API.md file created

100%

100%

All 6 endpoints documented

100%

100%

HTTP methods listed

100%

100%

One-line summaries

100%

100%

Required fields marked

100%

100%

Optional fields marked

100%

100%

Error responses documented

100%

100%

Success responses with status codes

100%

100%

Query parameters documented

100%

100%

Path parameters documented

100%

100%

Response body shapes shown

100%

100%

Evaluated
Agent
Claude Code
Model
Claude Sonnet 4.6

Table of Contents