OpenAPI or Postman #73
Comments
|
I'm not sure I understand what the difference is between what it currently
is and what a OpenAPI/Swagger/Postman implementation would be? You can hit
all the endpoints using Postman, is there something else that is missing?
…On Mon, Mar 23, 2020 at 10:43 AM Roderic Campbell ***@***.***> wrote:
Have you ever considered providing an OpenAPI/Swagger/Postman
implementation for this? If I get some time I'd consider creating a PR for
it.
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
<#73>, or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ABMQLHXQS42VGN6EJX5TJ7TRI6GSXANCNFSM4LSAKGXA>
.
|
|
An OpenAPI implementation there are tools available that will actually generate clients in any language. This helps in my specific case as creating the client can be quite cumbersome. |
|
Yeah, that would be awesome. If you wanted to create PR, I would be happy
to merge it in. The only thing I am concerned about is keeping it backward
compatible.
…On Mon, Mar 23, 2020 at 11:41 AM Roderic Campbell ***@***.***> wrote:
An OpenAPI implementation there are tools available that will actually
generate clients in any language. This helps in my specific case as
creating the client can be quite cumbersome.
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
<#73 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ABMQLHXNFZXNJQE4HANNDPLRI6NONANCNFSM4LSAKGXA>
.
|
|
I've started a draft here: https://app.swaggerhub.com/apis/Thumbworks/DeckOfCards/1.0.0. This'll allow you to export some large number of clients, including swift, which I'm interested in. The idea with my PR would be that I'd add the specific yaml file to a documents folder somewhere. Happy to collaborate if this is something you'd want quicker. As for keeping it backwards compatible, these yaml files have version numbers on them. |
|
I'm still a little confused; I apologize, I'm not the most experienced when
it comes to these things. So is this going to exist separately from the
main api? Or am I supposed to change the api to have all of these various
things defined?
…On Mon, Mar 23, 2020 at 1:11 PM Roderic Campbell ***@***.***> wrote:
I've started a draft here:
https://app.swaggerhub.com/apis/Thumbworks/DeckOfCards/1.0.0. This'll
allow you to export some large number of clients, including swift, which
I'm interested in. The idea with my PR would be that I'd add the specific
yaml file to a documents folder somewhere. Happy to collaborate if this is
something you'd want quicker.
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
<#73 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ABMQLHQSE3SC5OL5H5SGIDLRI6X7HANCNFSM4LSAKGXA>
.
|
|
I mean it depends how deep you want to go with this. One scenario is that you drop the yaml file in a docs directory like this: https://github.com/jamescmartinez/coffee/tree/master/docs. Next level after this would be to build files like urls.py and view.py using the yaml in the docs folder. With just dropping the file into the docs directory, you'd need to now keep 2 things up to date. I'm happy to hop on a call if you want, I'm not expert in this and you probably have a ton more context than I've got. |
|
I went ahead and auto generated some of a client library that I'd be interested in using: https://github.com/ThumbWorks/DeckOfCards. This then opens up opportunities to use swift package manager which I was interested in using. |
|
This is super interesting. I'll have to dig into it a little more. Thanks
for doing this!
…On Wed, Mar 25, 2020 at 12:31 AM Roderic Campbell ***@***.***> wrote:
I went ahead and auto generated some of a client library that I'd be
interested in using: https://github.com/ThumbWorks/DeckOfCards. This then
opens up opportunities to use swift package manager which I was interested
in using.
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
<#73 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ABMQLHUYEZCTTRKOLIXCG43RJGQN5ANCNFSM4LSAKGXA>
.
|
|
I'd spoken to a colleague about this and it became abundantly clear that I needed to add some usage in the README, so take a look at that to see what this gives you. In working on this I'd come up with some feedback items on the design of this API. I'd like to propose these in a new PR and/or issue if you're up for it. |
|
Of course, that would be great.
…On Wed, Mar 25, 2020 at 11:06 PM Roderic Campbell ***@***.***> wrote:
I'd spoken to a colleague about this and it became abundantly clear that I
needed to add some usage in the README, so take a look at that to see what
this gives you.
In working on this I'd come up with some feedback items on the design of
this API. I'd like to propose these in a new PR and/or issue if you're up
for it.
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
<#73 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ABMQLHUVIFBGP3MKRV3RTDDRJLPGPANCNFSM4LSAKGXA>
.
|
Have you ever considered providing an OpenAPI/Swagger/Postman implementation for this? If I get some time I'd consider creating a PR for it.
The text was updated successfully, but these errors were encountered: