search

mozvat / WSPAPIPrototype

Web Services 2.0 prototype work.
1 stars 2 forks source link

Discoverable APIs #3

Open mozvat opened 11 years ago

mozvat commented 11 years ago

There's not anything discoverable here: http://mercuryrestapi.azurewebsites.net. Should that list the apis available?

esear commented 11 years ago

I think a great way to make the APIs "discoverable" is to have a well defined resource model. Then you can use a tool like Swagger (https://developers.helloreverb.com/swagger/) to self-describe, visualize and even interact with the available services. Sample: http://petstore.swagger.wordnik.com/#!/user

Just looking at the screen you see the resources (user, pet, store) and what you can do with each.

sempf commented 11 years ago

Swagger is great, I think there are tools built into the WebAPI that will do this too.

esear commented 11 years ago

Thanks Bill - admittedly I know very little about the MSFT stack. I'm getting there, realizing that we are a MSFT shop. Can you recommend any resources that can assist in me getting up to speed with the MSFT view of REST? Just searching for WebAPI, I found these... MSFT turorials/intro to WebAPI: http://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api Book going into more detail: http://www.apress.com/9781430247258