Skip to main content

No project description provided

Project description

project description

zylo-docs
build the world’s best API docs highly integrated with FastAPI for developers

Supported Python versions


zylo-docs is built on FastAPI and automatically generates APIs written by users, adds descriptions using AI, and even supports API testing

A Simple Example

# zylo-docs boilerplate
from zylo_docs.integration import add_zylo_docs

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

# Add at the bottom
add_zylo_docs(app)

Running the FastAPI Server

uvicorn main:app --reload

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

sign up and sign in zylo

To use the Zylo service, please sign up or sign in.

use zylo-AI function

zylo-description

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

Development

  • Python 3.10+
  • FastAPI, Uvicorn

License

MIT License

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zylib_test-0.0.45.tar.gz (205.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

zylib_test-0.0.45-py3-none-any.whl (209.7 kB view details)

Uploaded Python 3

File details

Details for the file zylib_test-0.0.45.tar.gz.

File metadata

  • Download URL: zylib_test-0.0.45.tar.gz
  • Upload date:
  • Size: 205.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for zylib_test-0.0.45.tar.gz
Algorithm Hash digest
SHA256 50d224433453ec0c8671063e5dcaec054158741d92d2ad4a4704a4787f1a7122
MD5 cb1d5f9b84fde25b649607705d00c3c8
BLAKE2b-256 3e261fdd54006e469be3b8932005eaf71e2977f41e121be2164078d90c00ebbf

See more details on using hashes here.

File details

Details for the file zylib_test-0.0.45-py3-none-any.whl.

File metadata

  • Download URL: zylib_test-0.0.45-py3-none-any.whl
  • Upload date:
  • Size: 209.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for zylib_test-0.0.45-py3-none-any.whl
Algorithm Hash digest
SHA256 355c74a957f527e09e022e9098e7dfbf0a2bb6e4fdb31f421dada624b74d956f
MD5 3c3360102f5476049f27818551ed0705
BLAKE2b-256 a9a9e4cc231c8577389e2b26e75660429e28618c81eedf473fc448c6826ef6e8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page