starlette-apispec 1.0.2

内容

• Installation
  • About
• Usage
• More documentation
• Testing
• Contributing

Installation

pip install -U starlette-apispec

或者您也可以这样做

poetry add starlette-apispec

Usage

这个例子包括marshmallow集成

fromapispecimportAPISpecfromstarlette.applicationsimportStarlettefromstarlette.endpointsimportHTTPEndpointfromstarlette.testclientimportTestClientfromstarlette_apispecimportAPISpecSchemaGeneratorapp=Starlette()schemas=APISpecSchemaGenerator(APISpec(title="Example API",version="1.0",openapi_version="3.0.0",info={"description":"explanation of the api purpose"},))@app.websocket_route("/ws")defws(session):"""ws"""pass# pragma: no cover@app.route("/users",methods=["GET","HEAD"])deflist_users(request):"""
    responses:
    200:
        description: A list of users.
        examples:
        [{"username": "tom"}, {"username": "lucy"}]
    """pass# pragma: no cover@app.route("/users",methods=["POST"])defcreate_user(request):"""
    responses:
    200:
        description: A user.
        examples:
        {"username": "tom"}
    """pass# pragma: no cover@app.route("/orgs")classOrganisationsEndpoint(HTTPEndpoint):defget(self,request):"""
        responses:
        200:
            description: A list of organisations.
            examples:
            [{"name": "Foo Corp."}, {"name": "Acme Ltd."}]
        """pass# pragma: no coverdefpost(self,request):"""
        responses:
        200:
            description: An organisation.
            examples:
            {"name": "Foo Corp."}
        """pass# pragma: no cover@app.route("/schema",methods=["GET"],include_in_schema=False)defschema(request):returnschemas.OpenAPIResponse(request=request)

More documentation

这个包基本上是一个代理，所以如果你想知道怎么做， 以下是您需要的资源：

Starlette documentation

APISpec documentation

Testing

1. 复制回购协议
2. 激活venv. venv/bin/activate
3. 安装依赖项

poetry install

1. 运行测试

./scripts/test

Contributing

prs欢迎！