zylib-test 0.0.47

No project description provided

project description

Build the world’s best API docs highly integrated with FastAPI for developers

---

Writing technical documentation like API specs is often a burden for software engineers — it’s not their expertise, and rarely a top priority. That’s where Zylo-docs comes in. Zylo-docs seamlessly integrates with FastAPI and automatically generates OpenAPI-compliant specs. With powerful AI assistance, it helps developers create clear, user-friendly, and rich documentation with minimal effort. Think of it as a more intuitive, AI-powered alternative to Swagger.

Getting Started

# Please declare it like this.
from zylo_docs.integration import add_zylo_docs

@app.get("/")
async def read_root():
    return {"message": "Hello, FastAPI!"
    
# You need to add the following code at the bottom of your entry point file
add_zylo_docs(app)

Running the FastAPI Server

uvicorn main:app --reload

You need to start the server using Uvicorn.

After starting the server, open your browser and visit the root URL followed by http://localhost:8000/zylo-docs.

Sign up and sign in zylo

To use the Zylo ai service, please sign in.

Use zylo-docs ai function

By clicking the magic wand icon, you can use Zylo AI to generate descriptions and test cases for your API documentation.

Sharing API docs

Click the Publish button to share your API documentation with anyone you want.

Development

• Python 3.10+
• FastAPI, Uvicorn

License

MIT License