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

Frame 9

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.43.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.43-py3-none-any.whl (209.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: zylib_test-0.0.43.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.43.tar.gz
Algorithm Hash digest
SHA256 206fb3898a3733510632211dfc821fe921fc272e59e30c788d2763606d4c0a48
MD5 c931e58bbaaca18f9eb45fef9425dee2
BLAKE2b-256 1cdb905fc69807937658a67a19bbc841f0685e0ea33a1e6c6b9ec2c7b654495a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: zylib_test-0.0.43-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.43-py3-none-any.whl
Algorithm Hash digest
SHA256 46d89be6a1dc09662d063950313f122aabb971062dd3d59ae8f710c32b04ec30
MD5 b119156cdcc0fce5397e52a61bb40efb
BLAKE2b-256 cdeacb4a44a3b06e01c686b9e1e32ea0258efb18a8e692c00bfe5eb5740bfdec

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