Dredd: Add support for Open API 3.0

[johngluckmdsol]

It appears that version 3.0 is not yet supported. We're hoping to move to Open API 3.0 because we are better able to represent our JSON Schema with it. It would be great if your tool could suppor it.

[honzajavorek]

Regarding the Open API 3.0, we plan to support it, the question is when and the answer is yet to be determined. Of course anyone can come and contribute the support at any time, and we'll be there to help them - see https://github.com/apiaryio/dredd/issues/837#issuecomment-320020909

Related issues: https://github.com/apiaryio/fury-adapter-swagger/issues/131

[JurRutten]

+1

[veewee]

+1

[XVincentX]

Same here. I'd love to put the express-gateway API under tests but our specs are written in Open API 3.0!

[tombevers]

+1

[jonas-depop]

+1

[honzajavorek]

@tombevers @jonas-depop @JurRutten @veewee We understand this is a wanted feature, but next time please use GitHub Reactions to express your feelings. Thanks! ✨

By the way, one of the benefits is we can sort by the reactions:

[honzajavorek]

Just to reiterate, adding support for a new API description format goes like this...

Dredd consumes API Elements. It uses Fury.js to turn any API description format (currently API Blueprint and Swagger 2.0) into API Elements.

To produce API Elements for various formats, Fury.js uses adapters. So the first and the most important step to add support for OpenAPI 3.0 to Dredd would be to create an adapter for Fury, similar to the one for Swagger. The Fury.js maintainers (@apiaryio/adt) would definitely give a hand and advice to anyone who starts with this.

---

Note: A scheme of Dredd's parsing stack is in https://github.com/apiaryio/dredd/issues/820, I'd be happy to re-draw it and add it to docs if there's someone who actually needs it.

[altcatalin]

+1

[YGeorge]

Any update on this?

[michalholasek]

@YGeorge Implementation for initial OAS3 support is scheduled to start soon, but we don't have more accurate timeframe yet.

[joost]

+1

[nesl247]

@michalholasek Is there a timeframe at this point? It's been a few months since the last update. Curious to see how it's going.

[michalholasek]

@nesl247 There's no update on the timeframe yet, unfortunately.

[Miouge1]

Is there any alternatives to dredd to test OpenAPI 3.0?

[orontee]

+1

[jurgob]

+1

[jcagarcia]

+1

[honzajavorek]

@joost @jcagarcia @jurgob @orontee I'm sorry, but this is not helpful. See https://github.com/apiaryio/dredd/issues/894#issuecomment-348152513 I'm going to lock this issue now.

We, as the team behind the Apiary tools, would like to start with the adapter very soon.

It has two phases. First we need the Fury adapter mentioned earlier, which is the responsibility of @apiaryio/adt. When the adapter is ready, @apiaryio/sjs (currently me) can start working on bringing the very desired OAS3 support to Dredd. The adapter is going to be a parallel repository to https://github.com/apiaryio/fury-adapter-swagger, possibly something like https://github.com/apiaryio/fury-adapter-oas3, so watch out for that and when we kick it off, don't be afraid to give us a hand to make it all faster. See https://github.com/apiaryio/dredd/issues/894#issuecomment-354987264 to understand and do not hesitate to contact us in other issues for help and guidance.

This should stay as a tracking issue of OAS3 support in Dredd. We do track this as the most important thing to be worked on, so there's no need to add more 👍 . We hear you.

Thanks!

[honzajavorek]

The latest news about the adapter are under https://github.com/apiaryio/fury-adapter-swagger/issues/131#issuecomment-444849321. I'll keep updating this issue regarding support of OpenAPI 3 in Dredd specifically.

[honzajavorek]

With https://github.com/apiaryio/dredd/pull/1214 Dredd has an experimental support for OpenAPI 3 now!

Please see the status page for the list of supported features. The support of OpenAPI 3 in Dredd is experimental, beta, early, you name it. It is everything but finished. However, it already works - see https://github.com/apiaryio/api-elements.js/issues/71 for examples. The OAS3 adapter is now developed publicly at the new api-elements.js monorepo and accepts contributions.

I'd like to thank you all very much for waiting for so long. I'm very happy today Dredd is one very significant step closer to be again a great tool for everyone using API description documents as a source of truth for their APIs.

[ApiaryBot]

:tada: This issue has been resolved in version 7.1.0 :tada:

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot :package::rocket:

[Teklie]

Regarding the Open API 3.0, we plan to support it, the question is when and the answer is yet to be determined. Of course anyone can come and contribute the support at any time, and we'll be there to help them - see #837 (comment)

Related issues: apiaryio/fury-adapter-swagger#131

Hi @honzajavorek ,
is support for Open API 3.0 added?

Needed it :)

[priyanshuwustl]

@Teklie

With #1214 Dredd has an experimental support for OpenAPI 3 now!

Please see the status page for the list of supported features. The support of OpenAPI 3 in Dredd is experimental, beta, early, you name it. It is everything but finished. However, it already works - see apiaryio/api-elements.js#71 for examples. The OAS3 adapter is now developed publicly at the new api-elements.js monorepo and accepts contributions.

I'd like to thank you all very much for waiting for so long. I'm very happy today Dredd is one very significant step closer to be again a great tool for everyone using API description documents as a source of truth for their APIs.

Updated status page link: https://github.com/apiaryio/api-elements.js/blob/master/packages/openapi3-parser/STATUS.md