zylib-test 0.0.38

No project description provided

Zylo Docs

The world's best API docs for developers.

poetry 세팅 방법

방법.1 Poetry 깃허브 레포에서 직접 다운로드

curl -sSL https://install.python-poetry.org | python3 -

방법.2 pipx를 이용한 다운로드

pipx install poetry

설치 확인

poetry --version

의존성 라이브러리 설치

poetry install

VS Code 연동(vscode 말고도 에터가 poetry 가상환경을 인식못하는 경우 수동으로 연결)

1. VS Code에서 프로젝트 폴더 열기
2. Cmd+Shift+P → Python: Select Interpreter
3. .venv/bin/python 선택 만약 vscode가 자동으로 가상환경을 찾아서 등록해야 하는 작업을 해주면 된다

poetry 실행 명령어

poetry run uvicorn zylo-docs.main:app --port 8001 --reload

Installation

From PyPI (when published)

pip install zylo-docs

From source

git clone https://github.com/yourusername/zylo-docs.git
cd zylo-docs
pip install -e .

Usage

Integrate with your FastAPI app

Zylo Docs is a FastAPI plugin that adds a custom HTML-based API documentation UI at the /zylo route.

Example:

from fastapi import FastAPI
from zylo_docs.integration import mount_zylo_docs

app = FastAPI(title="My API")

@app.get("/users")
async def get_users():
    return {"users": ["user1", "user2"]}

# Integrate Zylo Docs UI with a single line
mount_zylo_docs(app)

Run the Zylo Docs server (for development/testing)

You can run the Zylo Docs server in two ways:

1. Using the CLI (recommended for quick start):

zylo-docs --reload

2. Using uvicorn directly:

uvicorn zylo_docs.main:app --reload

Access Zylo Docs

• Zylo UI: http://localhost:8000/zylo
• OpenAPI Spec: http://localhost:8000/openapi.json
• Your API: http://localhost:8000/users

How it works

• The UI served at /zylo is located at zylo_docs/static/index.html.
• Zylo Docs automatically loads your FastAPI OpenAPI spec from /openapi.json and displays it in the UI.
• You can integrate Zylo Docs into any FastAPI app with a single line.

Development

• Python 3.8+
• FastAPI, Uvicorn

License

MIT License