From ea6707fa4ca8cde7e5f7be9cef32e1598571d794 Mon Sep 17 00:00:00 2001 From: Nejc Zupan Date: Tue, 27 Oct 2020 23:58:21 +0000 Subject: [PATCH] Link to the PloneConf 2019 talk about pyramid_openapi3 (#98) --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dc9eccb..b2f81d1 100644 --- a/README.md +++ b/README.md @@ -47,13 +47,16 @@ The reason this package exists is to give you peace of mind when providing a RES - **A single source of truth**. Because of the checks outlined above you can be sure that whatever your API document says is in fact what is going on in reality. You have a single source of truth to consult when asking an API related question, such as "Remind me again, which fields does the endpoint /user/info return?". - Based on [Pyramid](https://trypyramid.com), a **mature Python Web framework**. Companies such as Mozilla, Yelp, RollBar and SurveyMonkey [trust Pyramid](https://trypyramid.com/community-powered-by-pyramid.html), and the new [pypi.org](https://github.com/pypa/warehouse) runs on Pyramid too. Pyramid is thoroughly [tested](https://travis-ci.org/Pylons/pyramid) and [documented](http://docs.pylonsproject.org/projects/pyramid/en/latest/), providing flexibility, performance, and a large ecosystem of [high-quality add-ons](https://trypyramid.com/extending-pyramid.html). +

+Building Robust APIs +

+ ## Features - Validates your API document (for example, `openapi.yaml` or `openapi.json`) against the OpenAPI 3.0 specification using the [openapi-spec-validator](https://github.com/p1c2u/openapi-spec-validator). - Generates and serves the [Swagger try-it-out documentation](https://swagger.io/tools/swagger-ui/) for your API. - Validates incoming requests *and* outgoing responses against your API document using [openapi-core](https://github.com/p1c2u/openapi-core). - ## Getting started 1. Declare `pyramid_openapi3` as a dependency in your Pyramid project. @@ -137,6 +140,7 @@ b) Validation approach does sacrifice DRY-ness, one has to write the API documen c) Generation approach has the drawback of having to write Python code even for parts of the API document that the Pyramid backend does not handle, as it might be handled by a different system, or be specific only to documentation or only to the client side of the API. This bloats your Pyramid codebase with code that does not belong there. + ## Running tests You need to have [pipenv](https://pipenv.readthedocs.io/) and Python 3.7 or 3.8 installed on your machine. Then you can run: