search

up9inc / mockintosh

Mocks for microservice environments
https://mockintosh.io
MIT License
169 stars 18 forks source link

OpenAPI spec to json conversion not complete #141

Closed rajmohanjiffy closed 3 years ago

rajmohanjiffy commented 3 years ago

I was testing out mockintosh for our enterprise - so, I downloaded the petstore swagger json example - Link here - and then tried to use the steps mockintosh provided to create automatic mocks.

I found that the created mocks does not provide complete functionality. When I did GET /pet/:petID, what I got was a dictionary of strings - wherein in reality, it was a dictionary of strings, arrays, and other dictionary.

Please fix the same. While I love the configuration driven (rather than UI) method followed by mockintosh, I am unable to recommend mockintosh because of this rather fundamental error. The question came that - this is too new a product, and if it cannot handle this, we do not know what all else might fail later.

mertyildiran commented 3 years ago

@rajmohanjiffy I'm sorry for the inconvenience. As of version 0.11 the -c/--convert flag does not perfectly transpile an OpenAPI Specification to a Mockintosh configuration. I think we should have stated that this feature is "experimental" in the docs.

Even if the feature is fully developed, the resulting Mockintosh configuration file might still require manual edits since there are subtle differences between an OAS document and a Mockintosh config.

Regarding the Petstore test case, I've started to work on improving the conversion feature and I'll get back to you as soon as I'm done.

rajmohanjiffy commented 3 years ago

Thank you very much. Manual edits are anyways expected, I guess. If it is close enough, I think it should be fine is what I feel. Also, what I have seen is that - other tools use example field and returns that if it conforms to the given format. That could be one option to look at.

On Mon, Jul 26, 2021 at 12:22 PM M. Mert Yıldıran @.***> wrote:

@rajmohanjiffy https://github.com/rajmohanjiffy I'm sorry for the inconvenience. As of version 0.11 the -c/--convert flag does not perfectly transpile an OpenAPI Specification to a Mockintosh configuration. I think we should have stated that this feature is "experimental" in the docs.

Even if the feature is fully developed, the resulting Mockintosh configuration file might still require manual edits since there are subtle differences between an OAS document and a Mockintosh config.

Regarding the Petstore test case, I've started to work on improving the conversion feature and I'll get back to you as soon as I'm done.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/up9inc/mockintosh/issues/141#issuecomment-886427267, or unsubscribe https://github.com/notifications/unsubscribe-auth/AU7B2P6SD6YKT2FR5FITA23TZUA2BANCNFSM5A7EWSUQ .

-- This email and any files transmitted with it are confidential and intended solely for the use of the individual or entity to whom it is addressed. If you are not the named addressee then you should not disseminate, distribute or copy this e-mail. Please notify the sender immediately and delete this e-mail from your system.

rajmohanjiffy commented 3 years ago

Also, Thank you very much for the very quick response, Mert. I was not expecting such a quick response - thank you.

On Mon, Jul 26, 2021 at 1:02 PM Rajmohan Harindranath @.***> wrote:

Thank you very much. Manual edits are anyways expected, I guess. If it is close enough, I think it should be fine is what I feel. Also, what I have seen is that - other tools use example field and returns that if it conforms to the given format. That could be one option to look at.

On Mon, Jul 26, 2021 at 12:22 PM M. Mert Yıldıran < @.***> wrote:

@rajmohanjiffy https://github.com/rajmohanjiffy I'm sorry for the inconvenience. As of version 0.11 the -c/--convert flag does not perfectly transpile an OpenAPI Specification to a Mockintosh configuration. I think we should have stated that this feature is "experimental" in the docs.

Even if the feature is fully developed, the resulting Mockintosh configuration file might still require manual edits since there are subtle differences between an OAS document and a Mockintosh config.

Regarding the Petstore test case, I've started to work on improving the conversion feature and I'll get back to you as soon as I'm done.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/up9inc/mockintosh/issues/141#issuecomment-886427267, or unsubscribe https://github.com/notifications/unsubscribe-auth/AU7B2P6SD6YKT2FR5FITA23TZUA2BANCNFSM5A7EWSUQ .

-- This email and any files transmitted with it are confidential and intended solely for the use of the individual or entity to whom it is addressed. If you are not the named addressee then you should not disseminate, distribute or copy this e-mail. Please notify the sender immediately and delete this e-mail from your system.

mertyildiran commented 3 years ago

@rajmohanjiffy you're welcome. Regarding the example field in the OAS specs, yes Mockintosh's transpiler overrides the mock with the value that's present in that field.