pyrs.swagger¶
Project homepage: https://github.com/palankai/pyrs-swagger
Documentation: http://pyrs-swagger.readthedocs.org/
Issue tracking: https://github.com/palankai/pyrs-swagger/issues
What is this package for¶
I’ve found Swagger a really useful tool for documenting any API. Unfortunately I haven’t found simple to use python package to create swagger documents. Swagger document actually is a JSON file. The specification is itself a JSON file too. Goal of this project provide tools for create this schema.
I’ve created the pyrs framework and this work also part of it. The swagger document generation can be based on pyrs.resource but not necessarily.
Nutshell¶
from pyrs import swagger
swagger = Swagger()
# options are dictionary contains the endpoint information
swagger.add('/user/', 'GET', options)
swagger.add('/user/', 'POST', options)
swagger.add('/user/<int: pk>', 'GET', options)
swagger.add('/user/<int: pk>', 'PUT', options)
swagger.add('/user/<int: pk>', 'DELETE', options)
swaggerjsondoc = swagger.build()
If you are using the other parts of the framework, the building would be easier
from pyrs import swagger
from pyrs import resource
@GET(inject_app=True)
def swagger(app):
swagger = Swagger()
swagger.discovery(app)
return swagger.build()
# in your pyrs application
class MyAPI(resource.App):
rwesources=(
#...
('/swagger.json', swagger),
#...
)
# then it should work magically
Features¶
- Easy definition
- Schema validation
- Extensible API
- Auto generation
Dependencies¶
See requirements.txt. Right now (as it will be the first commit) the goal is not define any hard dependency.
Important caveats¶
This code is in beta version. I working hard on write stable as possible API in the first place but while this code in 0.x version you should expect some major modification on the API.
The ecosystem¶
This work is part of pyrs framework. The complete framework follow the same intention to implement flexible solution.
Contribution¶
I really welcome any comments! I would be happy if you fork my code or create pull requests. I’ve already really strong opinions what I want to achieve and how, though any help would be welcomed.
Feel free drop a message to me!
Contribution¶
There are severe ways how can you help to make this work better. I welcome any kind of contribution. Please read the following chapters about how can you raise an issue, ask a new feature or actively improve the code.
Reporting a bug¶
You can report bugs or request any new feature on the official issue tracking of this project.
If you open an issue please give me detailed information about the bug.
First of all I need to know which environment where you are using it.
The most important think what I have to know which version what are you use.
If it’s the master branch, please mention the commit hash.
Second important think is the python version.
Please describe how can I reproduce, give me a small example or a
gist.
If you can attach traceback would be really appreciated.
Would help if you send me the pip freeze output and maybe the operating
system (I hope the different OS cannot cause any problem).
Milestones¶
Please select the milestone when you open an issue related to your version the code. If you couldn’t find that version (for example you are using 0.3.1 then you can find only 0.4, 0.5, 1.0) means that version is not supported. In that case I suppose you should test it against the recent version and report it then if it’s still an issue.
I’m planning to fix any real reported issue.
If you would like to open a feature request, please leave empty the milestone. I’ll will decide which version would contain this improvement.
Keep in mind, this project has it’s goals. I’m working on this project just in my spare time, so I cannot promise any work on any feature request.
Issue labels¶
I use almost the basic given configuration of github. Please follow that way. The bug should be marked as bug. A feature request should be enhancement.
Create pull request¶
I hope soon somebody help me to reach the project goals. If you would like to help me work on this project, please contact me first, we should agree about the planned work and how we should work together. I’ll review any pull request, though.
Any kind pull request, improvement should follow the coding standard of this framework. I plan to reach the %100 test coverage against the whole project. I’m using PEP8 validation against the whole code. Just tested and PEP8 conform code can be released.
Please see the Code styling documentation.
Code styling¶
This document would describe how should look like any part of this framework. I tend to update this document frequently, specify it as precise as possible.
Language¶
The language of the comments, documentation, variable names, function names have to be English. Use syntax and spell checker against any of them. (It’s a bit controversial, because I made lots of spelling mistakes, but I welcome any improvements.)
PEP8¶
Every python code should be checked with some kind of pep8 checking tool. Please enable all validation (by default some of the disabled). None of the PEP8 errors or warning allowed in release version.
The following thumb rules are PEP8 conform.
Use single quote¶
Use single quote if it’s possible. Double quote only allowed if you can avoid escaping with it. If you have escaping both ways you should use single quote.
Importing¶
There should be alphabetically sorted import sections. The sections are:
- Future
- Python Standard Library
- Third Party
- Current Python Project
- Explicitly Local (from . import x)
You should import modules and packages rather than classes or functions if it
could cause a conflict use as to make an alias. (In some cases importing
a class or a function allowed but try to avoid)
from __future__ import absolute_import
import json
import os
import psycopg2
import werkzeug
from pyrs.swagger import tests
from . import base
from . import conf
License¶
GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.
0. Additional Definitions.
As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.
"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.
An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.
A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library
with which the Combined Work was made is also called the "Linked
Version".
The "Minimal Corresponding Source" for a Combined Work means the
Corresponding Source for the Combined Work, excluding any source code
for portions of the Combined Work that, considered in isolation, are
based on the Application, and not on the Linked Version.
The "Corresponding Application Code" for a Combined Work means the
object code and/or source code for the Application, including any data
and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.
1. Exception to Section 3 of the GNU GPL.
You may convey a covered work under sections 3 and 4 of this License
without being bound by section 3 of the GNU GPL.
2. Conveying Modified Versions.
If you modify a copy of the Library, and, in your modifications, a
facility refers to a function or data to be supplied by an Application
that uses the facility (other than as an argument passed when the
facility is invoked), then you may convey a copy of the modified
version:
a) under this License, provided that you make a good faith effort to
ensure that, in the event an Application does not supply the
function or data, the facility still operates, and performs
whatever part of its purpose remains meaningful, or
b) under the GNU GPL, with none of the additional permissions of
this License applicable to that copy.
3. Object Code Incorporating Material from Library Header Files.
The object code form of an Application may incorporate material from
a header file that is part of the Library. You may convey such object
code under terms of your choice, provided that, if the incorporated
material is not limited to numerical parameters, data structure
layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:
a) Give prominent notice with each copy of the object code that the
Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the object code with a copy of the GNU GPL and this license
document.
4. Combined Works.
You may convey a Combined Work under terms of your choice that,
taken together, effectively do not restrict modification of the
portions of the Library contained in the Combined Work and reverse
engineering for debugging such modifications, if you also do each of
the following:
a) Give prominent notice with each copy of the Combined Work that
the Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the Combined Work with a copy of the GNU GPL and this license
document.
c) For a Combined Work that displays copyright notices during
execution, include the copyright notice for the Library among
these notices, as well as a reference directing the user to the
copies of the GNU GPL and this license document.
d) Do one of the following:
0) Convey the Minimal Corresponding Source under the terms of this
License, and the Corresponding Application Code in a form
suitable for, and under terms that permit, the user to
recombine or relink the Application with a modified version of
the Linked Version to produce a modified Combined Work, in the
manner specified by section 6 of the GNU GPL for conveying
Corresponding Source.
1) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (a) uses at run time
a copy of the Library already present on the user's computer
system, and (b) will operate properly with a modified version
of the Library that is interface-compatible with the Linked
Version.
e) Provide Installation Information, but only if you would otherwise
be required to provide such information under section 6 of the
GNU GPL, and only to the extent that such information is
necessary to install and execute a modified version of the
Combined Work produced by recombining or relinking the
Application with a modified version of the Linked Version. (If
you use option 4d0, the Installation Information must accompany
the Minimal Corresponding Source and Corresponding Application
Code. If you use option 4d1, you must provide the Installation
Information in the manner specified by section 6 of the GNU GPL
for conveying Corresponding Source.)
5. Combined Libraries.
You may place library facilities that are a work based on the
Library side by side in a single library together with other library
facilities that are not Applications and are not covered by this
License, and convey such a combined library under terms of your
choice, if you do both of the following:
a) Accompany the combined library with a copy of the same work based
on the Library, uncombined with any other library facilities,
conveyed under the terms of this License.
b) Give prominent notice with the combined library that part of it
is a work based on the Library, and explaining where to find the
accompanying uncombined form of the same work.
6. Revised Versions of the GNU Lesser General Public License.
The Free Software Foundation may publish revised and/or new versions
of the GNU Lesser General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the
Library as you received it specifies that a certain numbered version
of the GNU Lesser General Public License "or any later version"
applies to it, you have the option of following the terms and
conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you
received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser
General Public License ever published by the Free Software Foundation.
If the Library as you received it specifies that a proxy can decide
whether future versions of the GNU Lesser General Public License shall
apply, that proxy's public statement of acceptance of any version is
permanent authorization for you to choose that version for the
Library.