zylib-test 0.0.53

No project description provided

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.

[1/5] Get Started (Add boilerplate code)

from fastapi import FastAPI
# Please declare it at the top.
from zylo_docs.integration import add_zylo_docs

app = FastAPI()

@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(e.g main.py)
add_zylo_docs(app)

[2/5] Run the FastAPI Server

uvicorn main:app --reload

You need to start the server using Uvicorn.

Once the server is running, open your browser and go to: 👉 http://localhost:8000/zylo-docs
(⚠️ If your development server runs on a different port, update the URL accordingly!)

Tara! You can now view beautifully structured API specs with zylo-docs.

[3/5] To use Zylo AI, sign up and sign in to zylo.

To enhance your documentation with AI, please sign in to zylo-docs.

[4/5] Use the Zylo AI function to upgrade your docs

Click the magic wand icon in the top-right corner to activate Zylo AI, which will generate detailed descriptions and test cases for each of your API endpoints.

Tara! Your API specs are now upgraded and more user-friendly with zylo-docs.

After you find the red dot on the version selector, you can find the lastest one. Once you click it, you can check the new one filled with rich content.

[5/5] Share your API docs with your team

Click the Publish button to share your API documentation via email.

Development

• Python 3.10+
• FastAPI, Uvicorn

License

MIT License