Open BenSayers opened 7 years ago
+1 to this, I have been using this tool and it has worked great thus far. Having those extra features would be nice as well.
@BenSayers @ryandavis84 Interested in this one too. It ticks a lot of boxes for our public api consumption. For our internal services we're using Pact, for consumer-driven contract tests. However for our public apis where we can't really tell what our clients are relying on, we'd love to use something like this.
@stuartblair keep an eye on this project, it doesn’t do much yet but I’m expecting my team to get around to making it feature complete within the next 6 months: https://bitbucket.org/atlassian/openapi-diff
Also if you are using both Swagger and Pact you might be interested in this tool we developed to validate a Pact against a Swagger spec: https://bitbucket.org/atlassian/swagger-mock-validator
@BenSayers Thanks Ben! I did spot the swagger-mock-validator while looking for a solution a couple of weeks ago. Looked like a nice way of combining the two so that the consumer interactions are validated against the swagger prior to the normal pact validation.
I'll keep an eye on them. Thanks
Thanks @BenSayers, ill look into your project. Theres been a lot of talk about pact we just haven't moved forward with it. Ill be open sourcing somewhat of a swagger contract fuzz testing tool i wrote in java sometime soon. Or hopefully soon.
I also wanted to see what this would look like in java as a jar. Not sure how i feel about it but ill release it anyways. Makes it very easy to update with new rules. Trying to figure out how to get ready for OAS 3 though. I will share the project once i finish the last few rules.
I would be inclined to support a fork and expansion of committers list.
As promised, its not 100% by any means but from what i can tell it works pretty well.
https://github.com/ryandavis84/swagger-java-diff-cli
Just need to add some null testing and reduce all the code duplication as I put this together quickly. I am thinking of splitting up some of the description rules as well as some of the summary and external doc rules since they live in many places.
@BenSayers would you mind reviewing this PR to expose OpenAPIDiff for developers to use in addition to invoking it from the command line tool? I'm exploring this as a way of creating a custom matcher for Chai along the lines of
it('supports existing consumers', function() {
expect(newSpec).to.supportExistingConsumersOf(publishedSpec);
});
My team is currently exploring options for detecting breaking changes between Swagger files. After exploring what is available in the open source world at the moment this project seems the most mature, with the code being well structured and thoroughly tested đź‘Ť
We are juggling between contributing to this project or writing our own equivalent tool. Our concern with contributing to this project is there is there has not been a commit to this codebase in almost 5 months and a PR has been sitting in review for over 3 months.
Here is the list of swagger changes that this tool currently does not detect that we would be interested in adding support for (not comprehensive, just what we discovered during a few hours of spiking):
Is this project still alive? If we were to start working on this would you prefer many smaller PR's or fewer larger PR's?