spectree 0.1.0

generate OpenAPI document and validate request&response with Python annotations.

Spectree

Yet another library to generate OpenAPI document and validate request & response with Python annotations.

Features

• Less boilerplate code, annotations are really easy-to-use :sparkles:
• Generate API document with Redoc UI or Swagger UI :yum:
• Validate query, JSON data, response data with pydantic :wink:
• Current support:
  • Flask
  • Falcon
  • Starlette

Quick Start

install with pip: pip install spectree

Demo

Step by Step

1. Define your data structure with pydantic.BaseModel
2. create spectree.SpecTree instance with the web framework name you are using api = SpecTree('flask')
3. validate the route
   • query
   • json
   • headers
   • cookies
   • resp
   • tags
4. access these data with context(query, json, headers, cookies)
   • flask: request.context
   • falcon: req.context
   • starlette: request.context
5. register to the web application api.register(app)
6. check the document at URL location /apidoc/redoc or /apidoc/swagger

Examples

Check the examples folder.