API documentation, validation, mocking, and clients.
Project description
🛠 The Web API toolkit. 🛠
Community: https://discuss.apistar.org 🤔 💭 🤓 💬 😎
Documentation: https://docs.apistar.com 📘
API Star is a toolkit for working with OpenAPI or Swagger schemas. It allows you to:
- Build API documentation, with a selection of available themes.
- Validate API schema documents, and provide contextual errors.
- Validate requests and responses, using the API Star type system.
- Make API requests using the dynamic client library.
You can use it to build static documentation, integrate it within a Web framework, or use it as the client library for interacting with other APIs.
Quickstart
Install API Star:
$ pip3 install apistar
Let's take a look at some of the functionality the toolkit provides...
We'll start by creating an OpenAPI schema, schema.yml:
openapi: 3.0.0
info:
title: Widget API
version: '1.0'
description: An example API for widgets
servers:
- url: https://www.example.org/
paths:
/widgets:
get:
summary: List all the widgets.
operationId: listWidgets
parameters:
- in: query
name: search
description: Filter widgets by this search term.
schema:
type: string
Let's also create a configuration file apistar.yml:
schema:
path: schema.yaml
format: openapi
We're now ready to start using the apistar command line tool.
We can validate our OpenAPI schema:
$ apistar validate
✓ Valid OpenAPI schema.
Or build developer documentation for our API:
$ apistar docs --serve
✓ Documentation available at "http://127.0.0.1:8000/" (Ctrl+C to quit)
We can also make API requests to the server referenced in the schema:
$ apistar request listWidgets search=cogwheel
What did the server go?
With version 0.6 onwards the API Star project is being focused as a framework-agnositic suite of API tooling. The plan is to build out this functionality in a way that makes it appropriate for use either as a stand-alone tool, or together with a large range of frameworks.
The 0.5 branch remains available on GitHub, and can be installed from PyPI
with pip install apistar==0.5.41. Any further development of the API Star
server would likely need to be against a fork of that, under a new maintainer.
If you're looking for a high-performance Python-based async framework, then I would instead recommend Starlette.
API Star is BSD licensed code.
Designed & built in Brighton, England.
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
File details
Details for the file apistar-0.6.0.tar.gz.
File metadata
- Download URL: apistar-0.6.0.tar.gz
- Upload date:
- Size: 3.3 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/39.2.0 requests-toolbelt/0.8.0 tqdm/4.23.0 CPython/3.6.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4338b24468b49526ceac4a8f84046056081ee747f373ca8d0647bd6b2344c895 |
|
| MD5 | 6d3fbf1e8815299e8cd758367b4ad5a8 |
|
| BLAKE2b-256 | 64a3cd54d63d168504069974d40c941f03c7e7b0192aa22ecb20c05cb9e56bcc |
