apispec 0.4.2
pip install apispec==0.4.2
Newer version available (6.8.2)
Released:
A pluggable API documentation generator. Currently supports the Swagger 2.0 specification.
Navigation
Unverified details
These details have not been verified by PyPIProject links
Meta
- License: MIT License (Copyright 2015 Steven Loria, Josh Carp, and contributors)
- Author: Steven Loria, Josh Carp
- Tags apispec , swagger , spec , rest , api
Classifiers
- Development Status
- Intended Audience
- License
- Natural Language
- Programming Language
Project description
A pluggable API documentation generator. Currently supports the Swagger 2.0 specification.
Features
Supports Swagger 2.0
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',
description='A sample Petstore API.',
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",
# "description": "A sample Petstore API."
# "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.
Project details
Unverified details
These details have not been verified by PyPIProject links
Meta
- License: MIT License (Copyright 2015 Steven Loria, Josh Carp, and contributors)
- Author: Steven Loria, Josh Carp
- Tags apispec , swagger , spec , rest , api
Classifiers
- Development Status
- Intended Audience
- License
- Natural Language
- Programming Language
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
Built Distribution
File details
Details for the file apispec-0.4.2.tar.gz
.
File metadata
- Download URL: apispec-0.4.2.tar.gz
- Upload date:
- Size: 25.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
f3a1d9045f43e38354a217f1182275d6647e8414b8798767e6785f06c72eeb26
|
|
MD5 |
80aaae0396f4fdcfc4da7873ec79e55a
|
|
BLAKE2b-256 |
6051db9158998518d92d951e65f70171ad1cf7a83be58f08237450f07baa1c6b
|
File details
Details for the file apispec-0.4.2-py2.py3-none-any.whl
.
File metadata
- Download URL: apispec-0.4.2-py2.py3-none-any.whl
- Upload date:
- Size: 16.2 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
12b79a7fe0f4ac969974f6baf3b39c8c553104855007e60d85cc81b57bec5c6c
|
|
MD5 |
e981c56c6f05610cf64279e3bf2f295d
|
|
BLAKE2b-256 |
8778cd2a9c7c32d13747140e1bf584832aabdcc6413826217a3634aaf1119cd3
|