Use swagger2 for data model

[fizruk]

Closes #8.

This PR is incomplete, please do not merge yet.

[dmjio]

K

Sent from my iPhone

On Dec 22, 2015, at 1:10 PM, Nickolay Kudasov [email protected] wrote:

Closes #8.

This PR is incomplete, please do not merge yet.

You can view, comment on, or merge this pull request online at:

#9

Commit Summary

Add some commonly ignored files to .gitignore
Clear everything and add HasSwagger with instances for Post
Add HasSwagger instances for :<|> and :>
Add HasSwagger instance for Capture
Add HasSwagger instance for QueryParam
Add HasSwagger instance for QueryParams
Add HasSwagger instance for QueryFlag
Add HasSwagger instances for matrix params and flags
Add HasSwagger instance for Header
Add HasSwagger instance for ReqBody
Fix trailing slashes
Fix HasSwagger Raw instance
Allow HList in Headers as servant does
Add HasSwagger instance for Get
Add test suite with Todo API example
Add HasSwagger instances for the rest of servant methods
File Changes

M .gitignore (17)
M servant-swagger.cabal (40)
M src/Servant/Swagger.hs (108)
M src/Servant/Swagger/Internal.hs (1245)
A test/Servant/SwaggerSpec.hs (100)
A test/Spec.hs (1)
Patch Links:

https://github.com/dmjio/servant-swagger/pull/9.patch
https://github.com/dmjio/servant-swagger/pull/9.diff
—
Reply to this email directly or view it on GitHub.

[fizruk]

Things to do before merge:

• handle formData (probably with an instance for ReqBody '[FormUrlEncoded] a :> sub);
• add/reuse ToSample for schema examples;
• add helpers to annotate API with tags;
• add helpers to add/remove responses;
• add tons of tests/examples.

[fizruk]

Okay, I think schema examples and form data should be addressed in swagger2 first (see GetShopTV/swagger2#30 and GetShopTV/swagger2#31).

For tags/responses and other sub API / endpoint manipulation subOperations should do the job (see Hackage API example).

I am going to write some more examples/tests now.