swagger-annotation

Convert FastAPI controllers and Pydantic models into Chinese Swagger annotations.

5|1|Updated May 9, 2026
One-click install
npx skills add https://github.com/ql-link/LinkRag --skill swagger-annotation-ql-link
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: swagger-annotation
Source: https://github.com/ql-link/LinkRag/tree/main/.ai/skills/swagger-annotation
Command: npx skills add https://github.com/ql-link/LinkRag --skill swagger-annotation-ql-link

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This tool helps teams automatically generate clear, Chinese Swagger/OpenAPI annotations for FastAPI controllers and Pydantic models, reducing manual documentation effort.

Core Features & Use Cases

  • Generate Chinese titles, summaries, and descriptions for API endpoints.
  • Enforce consistent API documentation style across large FastAPI projects.
  • Use Case: A backend team wants to publish a Chinese OpenAPI doc set to guide frontend integration and API governance.

Quick Start

Annotate the given FastAPI route and Pydantic models with Chinese Swagger/OpenAPI descriptions to improve API documentation.

Frequently Asked Questions about swagger-annotation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate Chinese Swagger annotations for FastAPI controllers?

To generate Chinese Swagger annotations for FastAPI controllers, you apply this tool to automatically translate routes and Pydantic models into Chinese titles, summaries, and descriptions. It enforces consistent API documentation style across large projects to guide frontend integration.

Can I use Pydantic models to create enterprise-grade Chinese OpenAPI documentation?

Yes, you can use Pydantic models to create enterprise-grade Chinese OpenAPI documentation. The tool processes Pydantic schemas to inject Chinese descriptions, integrating seamlessly with FastAPI OpenAPI generation to enhance /docs clarity for frontend and backend collaboration.

What is the best way to enforce consistent Chinese API documentation style across FastAPI projects?

The best way to enforce consistent Chinese API documentation style across FastAPI projects is to apply automated annotation generation. It processes API groups and model schemas to ensure uniform Chinese titles and descriptions, reducing manual documentation effort.

Does FastAPI OpenAPI generation support automatic Chinese titles and descriptions for frontend collaboration?

FastAPI OpenAPI generation supports automatic Chinese titles and descriptions through this annotation tool. It integrates seamlessly with FastAPI's native OpenAPI generation to produce clear /docs pages, specifically designed to enhance frontend and backend collaboration.

How to annotate FastAPI routes and Pydantic models with Chinese Swagger descriptions?

To annotate FastAPI routes and Pydantic models with Chinese Swagger descriptions, you apply the tool across your API groups and schemas. It automatically converts existing definitions into enterprise-grade Chinese annotations, reducing manual documentation effort while improving API governance.