zylo-docs 1.2.2

Zylo-docs seamlessly integrates with FastAPI to automatically generate OpenAPI-compliant specs—so you can write your API docs faster and go home early.

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/10] Get Started (Add boilerplate code)

from fastapi import FastAPI
# 👇 [1/2] Add this import at the top
from zylo_docs import zylo_docs

app = FastAPI()
# 👇 [2/2] Add this your entry point file (e.g., main.py)
zylo_docs(app)

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

...
...
...

[2/10] 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!)

[3/10] Tada! You can now view beautifully structured API specs with zylo-docs.

[4/10] To use Zylo AI, sign up and sign in to zylo.

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

[5/10] Provide context to the zylo-docs AI

Context example

Our pet store is called "Patricia", and the pet_id represents the registered number of the pet. This should be reflected in the API specs.

Describe how you would like zylo-docs to enrich the document.

[6/10] Use the Zylo AI function to upgrade your docs

[7/10] 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.

[8/10] Compare the generated docs with the previous version

[9/10] Regenerate specific parts, such as test cases

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

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

• Note : Use authentication to test the token.
  • Use x-api by entering the key name and key value
  • Use HTTP Bearer by entering the Bearer token value.
  

Development

• Python 3.10+
• FastAPI, Uvicorn

License

MIT License