Re: Swagger for non-REST APIs

2017-04-18 Thread Dave Merrill
Thanks Tony, will investigate. Dave On Monday, April 17, 2017 at 7:09:35 PM UTC-4, tony tam wrote: > > Hi Dave, with the changes coming in the 3.0 spec, you can define schemas > for the input payloads and expect that inputs will have to match a schema > to “get in”. So that is a good thing and

Re: Swagger for non-REST APIs

2017-04-17 Thread tony tam
Hi Dave, with the changes coming in the 3.0 spec, you can define schemas for the input payloads and expect that inputs will have to match a schema to “get in”. So that is a good thing and seems to satisfy your first question. >From the docs point of view, we are currently working on how that wi

Re: Swagger for non-REST APIs

2017-04-17 Thread Dave Merrill
Actually, all of our inputs and outputs are quite strong typed, not in the Java actually-is-an-instance-of sense, since some access is across the web, but they are all named types, most of which have some sort of validation (regex, enum, array-of-this-type-of-object, etc). How do you guess the cha

Re: Swagger for non-REST APIs

2017-04-17 Thread tony tam
Hi Dave, you are describing a fairly typical RPC-style API, and it’s difficult to model those call with any REST framework. You can, however, look at what is being done in the 3.0 version of the specification behind Swagger (now called the Open API Specification) and see that we are supporting

Re: Swagger for non-REST APIs

2017-04-17 Thread Dave Merrill
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

Re: Swagger for non-REST APIs

2017-04-17 Thread tony tam
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, ju

Swagger for non-REST APIs

2017-04-17 Thread Dave Merrill
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 "Swagg