zylib-test 0.0.66

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
from zylo_docs.integration import add_zylo_docs # 👈 Add this import at the top

app = FastAPI()

@app.get("/")
async def read_root():
    return {"message": "Hello, FastAPI!"}

# ...
# ...
# 👇👇👇 KEEP SCROLLING... you're not done yet! 👇👇👇

# 👇 Add this 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.

⚡️ If your server is already running, you can skip this step.

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!)

Tada! 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.

Tada! Look at the red dot in the top-left corner! It is completed. Let's check this out!

After you find the red dot on the version selector, it means that our API specs are now upgraded and more user-friendly with zylo-docs. 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