![\"API](\"https://raw.githubusercontent.com/encode/apistar/master/docs/img/logo-200-square-light.png\"){kind=logo}
\n\n \n
\n \ud83d\udee0 The Web API toolkit. \ud83d\udee0\n
\n\n\n---\n\n**Community:** https://discuss.apistar.org \ud83e\udd14 \ud83d\udcad \ud83e\udd13 \ud83d\udcac \ud83d\ude0e\n\n**Documentation:** https://docs.apistar.com \ud83d\udcd8\n\n**Requirements:** Python 3.6+\n\n---\n\nAPI Star is a toolkit for working with OpenAPI or Swagger schemas. It allows you to:\n\n* Build API documentation, with a selection of available themes.\n* Validate API schema documents, and provide contextual errors.\n* Make API requests using the dynamic client library.\n\nYou can use it to build static documentation, integrate it within a Web framework,\nor use it as the client library for interacting with other APIs.\n\n## Quickstart\n\nInstall API Star:\n\n```bash\n$ pip3 install apistar\n```\n\nLet's take a look at some of the functionality the toolkit provides...\n\nWe'll start by creating an OpenAPI schema, `schema.yaml`:\n\n```yaml\nopenapi: 3.0.0\ninfo:\n title: Widget API\n version: '1.0'\n description: An example API for widgets\nservers:\n - url: https://www.example.org/\npaths:\n /widgets:\n get:\n summary: List all the widgets.\n operationId: listWidgets\n parameters:\n - in: query\n name: search\n description: Filter widgets by this search term.\n schema:\n type: string\n```\n\nLet's also create a configuration file `apistar.yml`:\n\n```yaml\nschema:\n path: schema.yaml\n format: openapi\n```\n\nWe're now ready to start using the `apistar` command line tool.\n\nWe can validate our OpenAPI schema:\n\n```\n$ apistar validate\n\u2713 Valid OpenAPI schema.\n```\n\nOr build developer documentation for our API:\n\n```\n$ apistar docs --serve\n\u2713 Documentation available at \"http://127.0.0.1:8000/\" (Ctrl+C to quit)\n```\n\nWe can also make API requests to the server referenced in the schema:\n\n```\n$ apistar request listWidgets search=cogwheel\n```\n\n## Where did the server go?\n\nWith version 0.6 onwards the API Star project is being focused as a\nframework-agnositic suite of API tooling. The plan is to build out this\nfunctionality in a way that makes it appropriate for use either as a stand-alone\ntool, or together with a large range of frameworks.\n\nThe 0.5 branch remains available on GitHub, and can be installed from PyPI\nwith `pip install apistar==0.5.41`. Any further development of the API Star\nserver would likely need to be against a fork of that, under a new maintainer.\n\nIf you're looking for a high-performance Python-based async framework, then\nI would instead recommend [Starlette](https://www.starlette.io/).\n\n---\n\nAPI Star is BSD licensed code.
Designed & built in Brighton, England.\n
\n ![\"API](\"https://raw.githubusercontent.com/encode/apistar/master/docs/img/ident-44-square-light.png\")
\n
![\"Build](\"https://travis-ci.org/encode/apistar.svg?branch=master\")
\n![\"codecov\"](\"https://codecov.io/gh/encode/apistar/branch/master/graph/badge.svg\"){kind=icon}
\n![\"Package](\"https://badge.fury.io/py/apistar.svg\"){kind=icon}
\n