On Jan 12, 2015, at 12:47 PM, Andrew Stuart wrote:
>I’m not a fan of integrating the Swagger specification into the code - seems
>to make for a VERY large amount of work, a huge amount of complexity and
>massive potential for introduction of bugs.
Agreed.
>I’ve taken the approach of a single sta
" as soon as Andrew loses interest in keeping it up to date.”
;-) I was never interested in keeping it up to date in the first place but I
can’t stand doing development without API documentation, a necessary first step
to coding to the API.
I do like your idea about changes to the API not being
With Swagger you can either:
1: integrate the spec into the API source code
or
2: have one single standalone JSON file that contains the whole specification
(api-docs.json in this case)
I’m not a fan of integrating the Swagger specification into the code - seems to
make for a VERY large amount
Barry Warsaw writes:
> My big question is how to make sure that the swagger spec doesn't
> get out of date to the implementation.
Doesn't Andrew's use case answer that? I mean, if the Swagger spec is
out of date, the tests based on it should fail. If the tests don't
fail, they're incomplete a
On Jan 11, 2015, at 08:51 AM, Andrew Stuart wrote:
>Attached is a first pass at a Swagger spec for the REST API.
>
>You can find out about Swagger at http://swagger.io
>
>The Swagger spec that I am working on is attached to this message or can be
>found here: http://www.mailripper.com/api-docs.jso
Andrew Stuart writes:
> The Swagger spec defines a way to document the methods, properties
> and return values of a REST API using JSON,
Aha. The Systers' students will like that, I think!
Thank you!
___
Mailman-Developers mailing list
Mailman-Devel
The Swagger spec defines a way to document the methods, properties and return
values of a REST API using JSON, and also provides a front end user interface
to turn that JSON into a functioning user interface to directly query the API.
There seems to be a few choices for documentation REST APIs a
Andrew Stuart writes:
> Attached is a first pass at a Swagger spec for the REST API.
>
> You can find out about Swagger at http://swagger.io
tmc;wr[1] Please explain briefly what Swagger is and why you're using
it rather than some similar product. Two lines is enough. I have
ZERO intention
Attached is a first pass at a Swagger spec for the REST API.
You can find out about Swagger at http://swagger.io
The Swagger spec that I am working on is attached to this message or can be
found here: http://www.mailripper.com/api-docs.json
If you want to see the attached spec in action against
