A pluggable API documentation generator. Currently supports the Swagger 2.0 specification.
Project description
A pluggable API documentation generator. Currently supports the OpenAPI specification (f.k.a. Swagger 2.0).
Features
Supports OpenAPI 2.0 specification (f.k.a. Swagger)
Framework-agnostic
Includes plugins for marshmallow and Flask
Utilities for parsing docstrings
Example Application
from apispec import APISpec
from flask import Flask, jsonify
from marshmallow import Schema, fields
# Create an APISpec
spec = APISpec(
title='Swagger Petstore',
version='1.0.0',
plugins=[
'apispec.ext.flask',
'apispec.ext.marshmallow',
],
)
# Optional marshmallow support
class CategorySchema(Schema):
id = fields.Int()
name = fields.Str(required=True)
class PetSchema(Schema):
category = fields.Nested(CategorySchema, many=True)
name = fields.Str()
# Optional Flask support
app = Flask(__name__)
@app.route('/random')
def random_pet():
"""A cute furry animal endpoint.
---
get:
description: Get a random pet
responses:
200:
description: A pet to be returned
schema: PetSchema
"""
pet = get_random_pet()
return jsonify(PetSchema().dump(pet).data)
ctx = app.test_request_context()
ctx.push()
# Register entities and paths
spec.definition('Category', schema=CategorySchema)
spec.definition('Pet', schema=PetSchema)
spec.add_path(view=random_pet)Generated Swagger Spec
spec.to_dict()
# {
# "info": {
# "title": "Swagger Petstore",
# "version": "1.0.0"
# },
# "swagger": "2.0",
# "paths": {
# "/random": {
# "get": {
# "description": "A cute furry animal endpoint.",
# "responses": {
# "200": {
# "schema": {
# "$ref": "#/definitions/Pet"
# },
# "description": "A pet to be returned"
# }
# },
# }
# }
# },
# "definitions": {
# "Pet": {
# "properties": {
# "category": {
# "type": "array",
# "items": {
# "$ref": "#/definitions/Category"
# }
# },
# "name": {
# "type": "string"
# }
# }
# },
# "Category": {
# "required": [
# "name"
# ],
# "properties": {
# "name": {
# "type": "string"
# },
# "id": {
# "type": "integer",
# "format": "int32"
# }
# }
# }
# },
# }Documentation
Documentation is available at http://apispec.readthedocs.org/ .
License
MIT licensed. See the bundled LICENSE file for more 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
apispec-0.9.1.tar.gz
(29.6 kB
view details)
Built Distribution
File details
Details for the file apispec-0.9.1.tar.gz.
File metadata
- Download URL: apispec-0.9.1.tar.gz
- Upload date:
- Size: 29.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | bd3a7ccb0c8cf6f9cc1e6f3960b657eaec939b9f7e1378d57091a13adf2db9c3 |
|
| MD5 | 3236822cbda762223fae835595d224f2 |
|
| BLAKE2b-256 | 1f42ab2ca692b57b73331a305f9e24a0520b6ba7438b3f1fdebf5385940a223b |
Provenance
File details
Details for the file apispec-0.9.1-py2.py3-none-any.whl.
File metadata
- Download URL: apispec-0.9.1-py2.py3-none-any.whl
- Upload date:
- Size: 18.1 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0529191e2ec8caeaa893b55bc53a2442c9fcc69cb6112fed747f1bb87aabae13 |
|
| MD5 | b9e1946e7a30ee60facd3082774f6dc0 |
|
| BLAKE2b-256 | 0d55cd102f0a86e89590a1b3d0bfbf0ac016dd3098eee2352d817fe7330829be |
