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.0.tar.gz
(29.7 kB
view details)
Built Distribution
File details
Details for the file apispec-0.9.0.tar.gz.
File metadata
- Download URL: apispec-0.9.0.tar.gz
- Upload date:
- Size: 29.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1b36412ad789999919939cce49b3fa2b7bb9d9ddd83da1c58a5a5d38c84ae470 |
|
| MD5 | bec3754b0cee3df87b3037520cdb1bb1 |
|
| BLAKE2b-256 | 0df751f1ed577a25e358c95d01a2d5fe4a6f62ff3ca0c44d319912d20780d16b |
Provenance
File details
Details for the file apispec-0.9.0-py2.py3-none-any.whl.
File metadata
- Download URL: apispec-0.9.0-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 | c9d4b1144b7d9f79081498b7ea3e5861874d3f4e22be037428404b618c41a125 |
|
| MD5 | a5b6f34fce7df83d7faad9cb20c921b8 |
|
| BLAKE2b-256 | 86f69af014bc7cdff461da54faf8a5c3748a8bcbdae8cde646e603d21ec7083c |
