معرفی شرکت ها

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

توضیحات

A python package which converts apidoc comments in various languages to OpenApi Spec .json files.

ویژگی	مقدار
سیستم عامل	-
نام فایل	apidoc-to-openapi-0.0.2
نام	apidoc-to-openapi
نسخه کتابخانه	0.0.2
نگهدارنده	[]
ایمیل نگهدارنده	[]
نویسنده	Graham Thomas
ایمیل نویسنده	grahamthethomas@gmail.com
آدرس صفحه اصلی	https://github.com/GrahamMThomas/apidoc_to_openapi
آدرس اینترنتی	https://pypi.org/project/apidoc-to-openapi/
مجوز	-

<img src="docs/apidoc-to-openapi_144px.png" align="right" /> # Apidoc to Openapi Converter   [![guide](https://img.shields.io/pypi/v/apidoc-to-openapi)](https://github.com/grahammthomas/apidoc_to_openapi) [Apidoc](http://apidocjs.com/) syntax is very easy and lightweight, whereas [Openapi aka Swagger](https://swagger.io/docs/specification/about/) syntax is very verbose and not noob friendly. The goal of this project is to make documenting api endpoints so easy that developers won't mind spending the time to do it, instead of just ignoring documentation. ## Apidoc conversion coverage Convertable Annotations: ``` @api @apiName @apiGroup @apiParam @apiSuccess ``` Feel free to PR in any other annotations you need. ### Installing ``` pip install apidoc-to-openapi ``` ``` usage: apidoc_to_openapi [-h] -i path [-o path] [--yaml] optional arguments: -h, --help show this help message and exit -o path File output (default: stdout) --yaml Convert output to yaml format Required: -i path File or directory containing apidoc annotations ``` #### Example ``` apidoc-to-openapi -i ./my/path/ -o ./my/path/swagger.yaml --yaml ``` ## Running the tests Used pytest for testing. Test coverage isn't near where I want it to be. ## Coding Style Using black formatter and pylint ## Authors - **Graham Thomas** - _Initial work_ ## License This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details ## Acknowledgments - I have no friends

نیازمندی

مقدار	نام
-	colorama
-	pyyaml

زبان مورد نیاز

مقدار	نام
>=3.6	Python

نحوه نصب

نصب پکیج whl apidoc-to-openapi-0.0.2:

pip install apidoc-to-openapi-0.0.2.whl

نصب پکیج tar.gz apidoc-to-openapi-0.0.2:

pip install apidoc-to-openapi-0.0.2.tar.gz