Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OpenAPI Validation #46

Open
cmheazel opened this issue Feb 26, 2018 · 4 comments
Open

OpenAPI Validation #46

cmheazel opened this issue Feb 26, 2018 · 4 comments
Assignees

Comments

@cmheazel
Copy link
Contributor

Note on requirement 36 - "Currently, no tool is known to validate that a server implements the API specified in its OpenAPI definition."
One result from the hackathon should be a first cut at Annex A and a strategy on how it will be tested using TeamEngine. A general purpose OpenAPI test (does your service conform to your OpenAPI advertisement) seems like a good place to start.

@cportele cportele added the Part 1: Core Issue related to Part 1 - Core label Feb 27, 2018
@cportele
Copy link
Member

By the way, I had a look at

before writing that statement. Later on https://swagger.io/swagger-inspector/ was released, but again only very basic tests are derived from the API definition, as far as I could tell. I have not yet had a really close look though.

It would be great to get something that tests at least some assertions out of the hackathon!

@cmheazel cmheazel self-assigned this Mar 7, 2018
@cmheazel
Copy link
Contributor Author

cmheazel commented Mar 7, 2018

Investigating an extension to Team Engine which will read an OpenAPI JSON document and then use it as the test document for that server (do you actually do what you claim to do). Biggest advantage is that the infrastructure and reporting will be the same as for all other OGC conformance tests.

@cmheazel
Copy link
Contributor Author

cmheazel commented Apr 5, 2018

The Abstract Test Suite calls for validation of the OpenAPI doc against the JSON Schema (under development). It then crawls through the OpenAPI document extracting the information it needs to perform the compliance tests. Not an exhaustive OpenAPI test suite, but it should validate the bits that we need.

@cportele
Copy link
Member

Here is another tool (based on Node.js): https://github.com/google/oatts

@cportele cportele added this to the Part 1, Second Draft Release milestone Aug 8, 2018
@cportele cportele removed this from the Part 1, Second Draft Release milestone Mar 5, 2019
@cportele cportele removed the Part 1: Core Issue related to Part 1 - Core label Mar 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants