diff options
Diffstat (limited to 'python-sanic-openapi.spec')
| -rw-r--r-- | python-sanic-openapi.spec | 383 |
1 files changed, 383 insertions, 0 deletions
diff --git a/python-sanic-openapi.spec b/python-sanic-openapi.spec new file mode 100644 index 0000000..05d0c9c --- /dev/null +++ b/python-sanic-openapi.spec @@ -0,0 +1,383 @@ +%global _empty_manifest_terminate_build 0 +Name: python-sanic-openapi +Version: 21.12.0 +Release: 1 +Summary: Easily document your Sanic API with a UI. +License: MIT +URL: http://github.com/sanic-org/sanic-openapi/ +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/14/c3/ddfd75ee001957af2a15727a101c476c83a15203ee878f172e8c58a64727/sanic-openapi-21.12.0.tar.gz +BuildArch: noarch + +Requires: python3-sanic +Requires: python3-pyyaml +Requires: python3-black +Requires: python3-flake8 +Requires: python3-isort +Requires: python3-coverage +Requires: python3-pytest +Requires: python3-pytest-cov +Requires: python3-pytest-html +Requires: python3-pytest-runner +Requires: python3-tox +Requires: python3-recommonmark +Requires: python3-sphinx +Requires: python3-sphinx-rtd-theme +Requires: python3-recommonmark +Requires: python3-sphinx +Requires: python3-sphinx-rtd-theme +Requires: python3-coverage +Requires: python3-pytest +Requires: python3-pytest-cov +Requires: python3-pytest-html +Requires: python3-pytest-runner +Requires: python3-tox + +%description +⚠️ This package is being replaced by [Sanic Extensions](https://sanicframework.org/en/plugins/sanic-ext/getting-started.html). The project will continue to be monitored, but no new features or major development is anticipated. Sanic Extensions contains a near 1:1 upgrade if you are using Sanic OpenAPI with OAS3. Ask in the [forums](https://community.sanicframework.org/) or [discord server](https://discord.gg/FARQzAEMAA) for questions about upgrading. + +# Sanic OpenAPI + +[](https://travis-ci.com/sanic-org/sanic-openapi) +[](https://pypi.python.org/pypi/sanic-openapi/) +[](https://pypi.python.org/pypi/sanic-openapi/) +[](https://github.com/python/black) +[](https://codecov.io/gh/sanic-org/sanic-openapi) + +Give your Sanic API a UI and OpenAPI documentation, all for the price of free! + + + +Check out [open collective](https://opencollective.com/sanic-org) to learn more about helping to fund Sanic. + + +## Installation + +```shell +pip install sanic-openapi +``` + +Add Swagger UI with the OpenAPI spec: + +```python +from sanic_openapi import swagger_blueprint + +app.blueprint(swagger_blueprint) +``` + +You'll now have a Swagger UI at the URL `/swagger/` and an OpenAPI 2.0 spec at `/swagger/swagger.json`. +Your routes will be automatically categorized by their blueprints. + +## OpenAPI 2 + +Here is an example to use Sanic-OpenAPI 2: + +```python +from sanic import Sanic +from sanic.response import json +from sanic_openapi import openapi2_blueprint + +app = Sanic(name="AwesomeApi") +app.blueprint(openapi2_blueprint) + + +@app.route("/") +async def test(request): + return json({"hello": "world"}) + + +if __name__ == "__main__": + app.run(host="0.0.0.0", port=8000) + +``` + +And you can get your Swagger document at <http://localhost:8000/swagger> like this: + + +## OpenAPI 3 + + +Here is an example to use Sanic-OpenAPI 3: + +```python +from sanic import Sanic +from sanic.response import json +from sanic_openapi import openapi3_blueprint + +app = Sanic(name="AwesomeApi") +app.blueprint(openapi3_blueprint) + + +@app.route("/") +async def test(request): + return json({"hello": "world"}) + + +if __name__ == "__main__": + app.run(host="0.0.0.0", port=8000) + +``` + +And you can get your Swagger document at <http://localhost:8000/swagger> like this: + + +## Documentation + +Please check the documentation on [Readthedocs](https://sanic-openapi.readthedocs.io) + +## Contribution + +Any contribution is welcome. If you don't know how to getting started, please check issues first and check our [Contributing Guide](CONTRIBUTING.md) to start you contribution. + + + + +%package -n python3-sanic-openapi +Summary: Easily document your Sanic API with a UI. +Provides: python-sanic-openapi +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-sanic-openapi +⚠️ This package is being replaced by [Sanic Extensions](https://sanicframework.org/en/plugins/sanic-ext/getting-started.html). The project will continue to be monitored, but no new features or major development is anticipated. Sanic Extensions contains a near 1:1 upgrade if you are using Sanic OpenAPI with OAS3. Ask in the [forums](https://community.sanicframework.org/) or [discord server](https://discord.gg/FARQzAEMAA) for questions about upgrading. + +# Sanic OpenAPI + +[](https://travis-ci.com/sanic-org/sanic-openapi) +[](https://pypi.python.org/pypi/sanic-openapi/) +[](https://pypi.python.org/pypi/sanic-openapi/) +[](https://github.com/python/black) +[](https://codecov.io/gh/sanic-org/sanic-openapi) + +Give your Sanic API a UI and OpenAPI documentation, all for the price of free! + + + +Check out [open collective](https://opencollective.com/sanic-org) to learn more about helping to fund Sanic. + + +## Installation + +```shell +pip install sanic-openapi +``` + +Add Swagger UI with the OpenAPI spec: + +```python +from sanic_openapi import swagger_blueprint + +app.blueprint(swagger_blueprint) +``` + +You'll now have a Swagger UI at the URL `/swagger/` and an OpenAPI 2.0 spec at `/swagger/swagger.json`. +Your routes will be automatically categorized by their blueprints. + +## OpenAPI 2 + +Here is an example to use Sanic-OpenAPI 2: + +```python +from sanic import Sanic +from sanic.response import json +from sanic_openapi import openapi2_blueprint + +app = Sanic(name="AwesomeApi") +app.blueprint(openapi2_blueprint) + + +@app.route("/") +async def test(request): + return json({"hello": "world"}) + + +if __name__ == "__main__": + app.run(host="0.0.0.0", port=8000) + +``` + +And you can get your Swagger document at <http://localhost:8000/swagger> like this: + + +## OpenAPI 3 + + +Here is an example to use Sanic-OpenAPI 3: + +```python +from sanic import Sanic +from sanic.response import json +from sanic_openapi import openapi3_blueprint + +app = Sanic(name="AwesomeApi") +app.blueprint(openapi3_blueprint) + + +@app.route("/") +async def test(request): + return json({"hello": "world"}) + + +if __name__ == "__main__": + app.run(host="0.0.0.0", port=8000) + +``` + +And you can get your Swagger document at <http://localhost:8000/swagger> like this: + + +## Documentation + +Please check the documentation on [Readthedocs](https://sanic-openapi.readthedocs.io) + +## Contribution + +Any contribution is welcome. If you don't know how to getting started, please check issues first and check our [Contributing Guide](CONTRIBUTING.md) to start you contribution. + + + + +%package help +Summary: Development documents and examples for sanic-openapi +Provides: python3-sanic-openapi-doc +%description help +⚠️ This package is being replaced by [Sanic Extensions](https://sanicframework.org/en/plugins/sanic-ext/getting-started.html). The project will continue to be monitored, but no new features or major development is anticipated. Sanic Extensions contains a near 1:1 upgrade if you are using Sanic OpenAPI with OAS3. Ask in the [forums](https://community.sanicframework.org/) or [discord server](https://discord.gg/FARQzAEMAA) for questions about upgrading. + +# Sanic OpenAPI + +[](https://travis-ci.com/sanic-org/sanic-openapi) +[](https://pypi.python.org/pypi/sanic-openapi/) +[](https://pypi.python.org/pypi/sanic-openapi/) +[](https://github.com/python/black) +[](https://codecov.io/gh/sanic-org/sanic-openapi) + +Give your Sanic API a UI and OpenAPI documentation, all for the price of free! + + + +Check out [open collective](https://opencollective.com/sanic-org) to learn more about helping to fund Sanic. + + +## Installation + +```shell +pip install sanic-openapi +``` + +Add Swagger UI with the OpenAPI spec: + +```python +from sanic_openapi import swagger_blueprint + +app.blueprint(swagger_blueprint) +``` + +You'll now have a Swagger UI at the URL `/swagger/` and an OpenAPI 2.0 spec at `/swagger/swagger.json`. +Your routes will be automatically categorized by their blueprints. + +## OpenAPI 2 + +Here is an example to use Sanic-OpenAPI 2: + +```python +from sanic import Sanic +from sanic.response import json +from sanic_openapi import openapi2_blueprint + +app = Sanic(name="AwesomeApi") +app.blueprint(openapi2_blueprint) + + +@app.route("/") +async def test(request): + return json({"hello": "world"}) + + +if __name__ == "__main__": + app.run(host="0.0.0.0", port=8000) + +``` + +And you can get your Swagger document at <http://localhost:8000/swagger> like this: + + +## OpenAPI 3 + + +Here is an example to use Sanic-OpenAPI 3: + +```python +from sanic import Sanic +from sanic.response import json +from sanic_openapi import openapi3_blueprint + +app = Sanic(name="AwesomeApi") +app.blueprint(openapi3_blueprint) + + +@app.route("/") +async def test(request): + return json({"hello": "world"}) + + +if __name__ == "__main__": + app.run(host="0.0.0.0", port=8000) + +``` + +And you can get your Swagger document at <http://localhost:8000/swagger> like this: + + +## Documentation + +Please check the documentation on [Readthedocs](https://sanic-openapi.readthedocs.io) + +## Contribution + +Any contribution is welcome. If you don't know how to getting started, please check issues first and check our [Contributing Guide](CONTRIBUTING.md) to start you contribution. + + + + +%prep +%autosetup -n sanic-openapi-21.12.0 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-sanic-openapi -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 21.12.0-1 +- Package Spec generated |