swagger-js

25 views
Skip to first unread message

Jacob Brauchler

unread,
Jul 8, 2015, 2:28:49 PM7/8/15
to swagger-sw...@googlegroups.com
Can someone tell me what swagger-js/swagger-client is used for? Is this a way to generate the code from the documentation? I read through the documentation and I am a little confused on what it actually does.

Josh Ponelat

unread,
Jul 9, 2015, 1:41:52 AM7/9/15
to swagger-sw...@googlegroups.com
If you don't know already, perhaps a little bg on swagger.
Swagger is a way of describing APIs. You describe your API in a swagger.json file (or similar).

swagger-js(npm: swagger-client) does a couple of things...
it de-references swagger.json files that have remote references
it can execute http requests based on that swagger.json fille, passing in arguments, etc.
for now it also includes rendering JSON and HTML of the models used in the API (although I imagine this will be extracted soon into swagger-ui, or as an independent module) This is for documentation purposes.

Hope that helps, there is the website http://swagger.io and of course the https://github.com/swagger-api/swagger-js for more info!

On 8 July 2015 at 20:28, Jacob Brauchler <jacob.b...@pensco.com> wrote:
Can someone tell me what swagger-js/swagger-client is used for? Is this a way to generate the code from the documentation? I read through the documentation and I am a little confused on what it actually does.

This information is privileged and confidential and is intended only for the person or entity to which it is addressed. Any review, retransmission, dissemination or other use of this information (including attachments) by persons or entities other than the intended recipient is prohibited. If you are not the intended recipient, please delete the information from your system and contact the sender.

--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Jacob Brauchler

unread,
Jul 9, 2015, 9:56:48 AM7/9/15
to swagger-sw...@googlegroups.com
Okay thats kind of what I was thinking I have been using swagger for a little while and was searching for a specific tool, and unfortunately the tool I need is outdated, so I was looking for a replacement.
Reply all
Reply to author
Forward
0 new messages