zylib-test 0.0.52

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 (Write a boilerplate on your 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 (http://localhost:8000/zylo-docs)

uvicorn main:app --reload

You need to start the server using Uvicorn.

After launching the server, navigate to http://localhost:8000/zylo-docs in your browser.
(If the development server port changes, the port number in the execution command must also change)

Tara! You can see decent API specs with zylo-docs.

[3/5] In order to use Zylo AI, Sign up and sign in zylo

In order to upgrade your docs, please sign in into zylo-docs.

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

By clicking the magic wand icon at the top-right, you can call Zylo AI to generate detail descriptions and test cases for your each API endpoints.

[5/5] Sharing API docs with your colleagues

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

Development

• Python 3.10+
• FastAPI, Uvicorn

License

MIT License