NEWA RESTful API using Swagger

[theason]

Ok, I'll admit it. I seem to have gotten stuck drinking MSFT cool-aid for too many years. The transition from SOAP to WCF was pretty reasonable, but this JSON stuff that's all the rage with the cool kids has me a bit mystified. I can fully appreciate you wanting to use this system as a competing standard to WCF because it removes that dependency on MSFT, so please don't take this as a rant against it. I'm willing to work with it

Can somebody help a poor old MSFT guy with your new fancy Swagger documented API? Can I somehow generate all the classes from the API; and make calls to the API with the old school things I am used to, or do I really need to invoke the HTTP methods and make all the calls myself, passing everything correctly. You know, like we used to do with the WSDL generator?

The interwebs is full of people talking about how to use the Swagger system to document code, but nobody seems to have a guide for generating the classes for your client (particularly when it comes to .net clients).

Hint: Maybe the project itself already has the objects I'm looking for and they could be provided

Thanks!

[bgowland]

...but this JSON stuff that's all the rage with the cool kids has me a bit mystified.

Wow, I'm a "cool kid".

Can I somehow generate all the classes from the API; and make calls to the API with the old school things I am used to, or do I really need to invoke the HTTP methods and make all the calls myself, passing everything correctly. You know, like we used to do with the WSDL generator?

Search Google for "generate classes from swagger" - there's a Github project out there. I haven't tried it as I'm personally just doing boiler-plate stuff at the moment as it fits my needs for testing (I don't need the full set of services yet).

Hint: Maybe the project itself already has the objects I'm looking for and they could be provided Thanks!

The source for NEWA is provided as it always has been bearing in mind it's an ASP.NET app.

I suspect UJB can give you more information though.

Cheers,
Brian

[UncleJohnsBand]

The API doc tells you about the different locations and necessary values. Although the API doc allows direct interaction with the services I find it not to work all the time.

I much prefer using the Chrome plugin Advanced Rest client to interact with the API's.

Objects that need to be submitted I believe I have included an API to get a default JSON object that can be used on Post's. If you want to make a corresponding c# class you could look for a JSON to c# class converter.

JSON is a RESTful transaction service implementation and most often does not need submission of objects.

API's are exected based on url. Sometimes you pass a parameter in as part of the url path /public/api-method-name/value-to-pass othertimes you are just doing a query /public/api-method-name/ and other times you may use querystrings as additional identifiers for the API call /public/api-method/value-to-pass?parm1=abc&parm2=123

with the introduction of a security token that will come out in the next release of NEWA and NPVR you can securely access the API over the internet without worry of someone running the API's without permission.

As for the Swagger documentation specification.... I spent a good week or so researching.... nothing provides you automated full-proof generation.

I simply opted to build in a stand alone implementation and manually create an maintain the doc objects.

The web/api/ directory in NEWA is a full stand-alone implementation of the Swagger documentation standard. Once you code the classes for the documentation a few times it really isn't that bad.