Skip to main content

Stopments

Stoplight elements static files

Refered from FastAPI's #5168 PR

It includes the following files:

  • styles.min.css
  • web-components.min.js
  • favicon.ico
  • scalar-api-reference.js (for scalar)

The static files were collected on the same date as this package version.

Installation

pip install stopments

Usage

from fastapi import FastAPI
from fastapi.responses import HTMLResponse
from fastapi.staticfiles import StaticFiles

from stopments import get_stoplight_elements_html

app = FastAPI(docs_url=None, redoc_url=None)

@app.get("/docs/", include_in_schema=False)
async def docs():
    html = get_stoplight_elements_html(
        openapi_url=app.openapi_url or "/openapi.json",
        title="API Documentation",
    )
    return HTMLResponse(content=html)

or you can use embedded static files

from fastapi import FastAPI
from fastapi.responses import HTMLResponse
from fastapi.staticfiles import StaticFiles

from stopments import get_stoplight_elements_html

app = FastAPI(docs_url=None, redoc_url=None)
app.mount("/static", StaticFiles(packages=[("stopments", "static")]))

@app.get("/docs/", include_in_schema=False)
async def docs():
    html = get_stoplight_elements_html(
        openapi_url=app.openapi_url or "/openapi.json",
        title="API Documentation",
        stoplight_elements_css_url="/static/styles.min.css",
        stoplight_elements_js_url="/static/web-components.min.js",
        stoplight_elements_favicon_url="/static/favicon.ico",
    )
    return HTMLResponse(content=html)

References

Download files

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

Source Distribution

stopments-26.8.1.tar.gz (1.8 MB view details)

Uploaded Source

Built Distribution

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

stopments-26.8.1-py3-none-any.whl (1.8 MB view details)

Uploaded Python 3

File details

Details for the file stopments-26.8.1.tar.gz.

File metadata

  • Download URL: stopments-26.8.1.tar.gz
  • Upload date:
  • Size: 1.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for stopments-26.8.1.tar.gz
Algorithm Hash digest
SHA256 dcaae34d323e8c5b3132da6273dd45e8ebaa6f50ccd31225ef69417a80704888
MD5 254c520b74cd0d65798a6eb0bf764fa9
BLAKE2b-256 86f46b94e2036e5269ab73b2582b1e72f58f533afb6f69be8532c206221a8f22

See more details on using hashes here.

Provenance

The following attestation bundles were made for stopments-26.8.1.tar.gz:

Publisher: release.yaml on Bing-su/stopments

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file stopments-26.8.1-py3-none-any.whl.

File metadata

  • Download URL: stopments-26.8.1-py3-none-any.whl
  • Upload date:
  • Size: 1.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for stopments-26.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 15a03c938247415f24e55910d7559774c4e2154f2a5a96e7b111b1d24e92e205
MD5 7c6ad1a43f9ecf4826fa4d7c666cd897
BLAKE2b-256 29c656898158d2a1746782ddedce377063135db255dcde378380056c78cc43b4

See more details on using hashes here.

Provenance

The following attestation bundles were made for stopments-26.8.1-py3-none-any.whl:

Publisher: release.yaml on Bing-su/stopments

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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