apistar


Nameapistar JSON
Version 0.7.2 PyPI version JSON
download
home_pagehttps://docs.apistar.com/
SummaryAPI documentation, validation, mocking, and clients.
upload_time2019-04-03 08:12:14
maintainer
docs_urlNone
authorTom Christie
requires_python>=3.6
licenseBSD
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            <p align="center">
    <img src="https://raw.githubusercontent.com/encode/apistar/master/docs/img/logo-200-square-light.png" alt="API Star" />
</p>
<p align="center">
    🛠 <em>The Web API toolkit.</em> 🛠
</p>
<p align="center">
<a href="https://travis-ci.org/encode/apistar">
    <img src="https://travis-ci.org/encode/apistar.svg?branch=master" alt="Build Status">
</a>
<a href="https://codecov.io/gh/encode/apistar">
    <img src="https://codecov.io/gh/encode/apistar/branch/master/graph/badge.svg" alt="codecov">
</a>
<a href="https://pypi.python.org/pypi/apistar">
    <img src="https://badge.fury.io/py/apistar.svg" alt="Package version">
</a>
</p>

---

**Community:** https://discuss.apistar.org 🤔 💭 🤓 💬 😎

**Documentation:** https://docs.apistar.com 📘

**Requirements:** Python 3.6+

---

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.
* 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:

```bash
$ 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.yaml`:

```yaml
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`:

```yaml
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
```

## Where 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](https://www.starlette.io/).

---

<p align="center"><i>API Star is <a href="https://github.com/tomchristie/apistar/blob/master/LICENSE.md">BSD licensed</a> code.<br/>Designed & built in Brighton, England.</i>
<p align="center">
    <img src="https://raw.githubusercontent.com/encode/apistar/master/docs/img/ident-44-square-light.png" alt="API Star" />
</p>

Raw data

            {
    "_id": null,
    "home_page": "https://docs.apistar.com/",
    "name": "apistar",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "",
    "author": "Tom Christie",
    "author_email": "tom@tomchristie.com",
    "download_url": "https://files.pythonhosted.org/packages/d6/0c/3066b856f661bc58b16c1a2ff4eeed25dc4f0d4618871b3454066dad89e0/apistar-0.7.2.tar.gz",
    "platform": "",
    "description": "<p align=\"center\">\n    <img src=\"https://raw.githubusercontent.com/encode/apistar/master/docs/img/logo-200-square-light.png\" alt=\"API Star\" />\n</p>\n<p align=\"center\">\n    \ud83d\udee0 <em>The Web API toolkit.</em> \ud83d\udee0\n</p>\n<p align=\"center\">\n<a href=\"https://travis-ci.org/encode/apistar\">\n    <img src=\"https://travis-ci.org/encode/apistar.svg?branch=master\" alt=\"Build Status\">\n</a>\n<a href=\"https://codecov.io/gh/encode/apistar\">\n    <img src=\"https://codecov.io/gh/encode/apistar/branch/master/graph/badge.svg\" alt=\"codecov\">\n</a>\n<a href=\"https://pypi.python.org/pypi/apistar\">\n    <img src=\"https://badge.fury.io/py/apistar.svg\" alt=\"Package version\">\n</a>\n</p>\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\n<p align=\"center\"><i>API Star is <a href=\"https://github.com/tomchristie/apistar/blob/master/LICENSE.md\">BSD licensed</a> code.<br/>Designed & built in Brighton, England.</i>\n<p align=\"center\">\n    <img src=\"https://raw.githubusercontent.com/encode/apistar/master/docs/img/ident-44-square-light.png\" alt=\"API Star\" />\n</p>",
    "bugtrack_url": null,
    "license": "BSD",
    "summary": "API documentation, validation, mocking, and clients.",
    "version": "0.7.2",
    "project_urls": {
        "Homepage": "https://docs.apistar.com/"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d60c3066b856f661bc58b16c1a2ff4eeed25dc4f0d4618871b3454066dad89e0",
                "md5": "bec6e066702370e5ab376624800e1926",
                "sha256": "8da0d3f15748c8ed6e68914ba5b8f6dd5dff5afbe137950d07103575df0bce73"
            },
            "downloads": -1,
            "filename": "apistar-0.7.2.tar.gz",
            "has_sig": false,
            "md5_digest": "bec6e066702370e5ab376624800e1926",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 3276455,
            "upload_time": "2019-04-03T08:12:14",
            "upload_time_iso_8601": "2019-04-03T08:12:14.678357Z",
            "url": "https://files.pythonhosted.org/packages/d6/0c/3066b856f661bc58b16c1a2ff4eeed25dc4f0d4618871b3454066dad89e0/apistar-0.7.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2019-04-03 08:12:14",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "apistar"
}
Tom Christie
Elapsed time: 0.69423s