pyramid_openapi3 released under Pylons Project

26 views
Skip to first unread message

Nejc Zupan

unread,
May 22, 2019, 5:31:33 AM5/22/19
to pylons-...@googlegroups.com
Hey all!

Last summer, Domen and I started working on an OpenAPI 3.0 integration package for Pyramid.
After almost a year of refinement and running it in production, I’m finally ready to announce
it to the wider community.

The reason this package exists is to give you peace of mind when providing a RESTful API.
Instead of chasing down preventable bugs and saying sorry to consumers, you can focus on
more important things in life. 

Features:
* Validates your API document (openapi.yaml) against the OpenAPI 3.0 specification.
* Validates incoming requests and outgoing responses against your API document.
* Generates and serves the Swagger try-it-out documentation for your API.

The package comes with several runnable demos:

The package, and all examples, are covered with tests and type hints, and a bunch of linters.
As of recently, pyramid_openapi3 lives under the Pylons Project umbrella. 

Enjoy!



z.

Julien Cigar

unread,
May 22, 2019, 6:17:53 AM5/22/19
to pylons-...@googlegroups.com
On Wed, May 22, 2019 at 11:31:22AM +0200, Nejc Zupan wrote:
> Hey all!
>
> Last summer, Domen and I started working on an OpenAPI 3.0 integration package for Pyramid.
> After almost a year of refinement and running it in production, I’m finally ready to announce
> it to the wider community.
>
> The reason this package exists is to give you peace of mind when providing a RESTful API.
> Instead of chasing down preventable bugs and saying sorry to consumers, you can focus on
> more important things in life.
>
> Features:
> * Validates your API document (openapi.yaml) against the OpenAPI 3.0 specification.
> * Validates incoming requests and outgoing responses against your API document.
> * Generates and serves the Swagger try-it-out documentation for your API.
>
> The package comes with several runnable demos:
> * A single-file example: https://github.com/Pylons/pyramid_openapi3/tree/master/examples/singlefile <https://github.com/Pylons/pyramid_openapi3/tree/master/examples/singlefile>
> * A simple TODO-app example: https://github.com/Pylons/pyramid_openapi3/tree/master/examples/todoapp <https://github.com/Pylons/pyramid_openapi3/tree/master/examples/todoapp>
> * A RealWorld.io <http://realworld.io/> implementation: https://github.com/niteoweb/pyramid-realworld-example-app <https://github.com/niteoweb/pyramid-realworld-example-app>
>
> The package, and all examples, are covered with tests and type hints, and a bunch of linters.
> As of recently, pyramid_openapi3 lives under the Pylons Project umbrella.
>
> Enjoy!
>
> https://pypi.org/project/pyramid-openapi3/ <https://pypi.org/project/pyramid-openapi3/>

Thank you for the work and the addition to the Pyramid ecosystem :)

I was wondering if it integrates well with Traversal as all examples and
documentation seems to use URL Dispatch only ..?

Julien

>
>
> z.
>
> --
> You received this message because you are subscribed to the Google Groups "pylons-discuss" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to pylons-discus...@googlegroups.com.
> To post to this group, send email to pylons-...@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/pylons-discuss/6A2BDB98-AAD8-43A7-AA54-94D3228443C4%40gmail.com.
> For more options, visit https://groups.google.com/d/optout.

--
Julien Cigar
Belgian Biodiversity Platform (http://www.biodiversity.be)
PGP fingerprint: EEF9 F697 4B68 D275 7B11 6A25 B2BB 3710 A204 23C0
No trees were killed in the creation of this message.
However, many electrons were terribly inconvenienced.
signature.asc

Nejc Zupan

unread,
May 22, 2019, 6:26:26 AM5/22/19
to pylons-...@googlegroups.com
On 22 May 2019, at 11:47, Julien Cigar <jul...@perdition.city> wrote:

On Wed, May 22, 2019 at 11:31:22AM +0200, Nejc Zupan wrote:

Thank you for the work and the addition to the Pyramid ecosystem :)

I was wondering if it integrates well with Traversal as all examples and
documentation seems to use URL Dispatch only ..?

I haven’t really used Traversal much (really, at all) since my Plone days,
so I wouldn’t know. Happy to discuss approaches or pull requests!


z.
Reply all
Reply to author
Forward
0 new messages