Thanks for getting back Tony. A bit more context: An app I work on has a largely HTML/JS/Ajax front end, but also supports server-side customization, where our back-end methods can be called by native customer code, no HTTP involved. Additionally, the parts that are called via HTTP/Ajax aren't REST at all, they're simple GET or POST requests to a common front controller URL, with the object and method to be called and any parameters in URL or form variables.
>From what I've seen of Swagger and API Blueprint, both require a) different URI endpoints for different target objects, b) different HTTP verbs for the canonical REST/CRUD actions, and c) REST-specific HTTP response codes. Am I right about that? If so, as you say, it's kind of a square peg/round hole problem. The editing environment, mocks, generated stubs, really the whole ecosystem, would all fight you if you tried to use them in that context. If that's the case, are you aware of any API design tools or description languages that might be a better fit? Thanks again very much for your time and thoughts, Dave On Monday, April 17, 2017 at 1:36:46 PM UTC-4, tony tam wrote: > > Hi Dave, you sort of can, but it’s going a bit against the grain. The > ecosystem is more intended for rest-like APIs, although being “strictly” or > even “proper” restful is certainly not a requirement. > > On Apr 17, 2017, at 5:00 AM, Dave Merrill wrote: > > Hi folks, I'm brand new to Swagger, just looking at its capabilities. > > Is it possible to use Swagger to document APIs that don't use REST, just > standard component.someMethod(someArg="foo", [...]) calls? > > Thanks. > > -- > 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 [email protected] <javascript:>. > For more options, visit https://groups.google.com/d/optout. > > > -- 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 [email protected]. For more options, visit https://groups.google.com/d/optout.
