Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Complete support for REST API #2

Closed
7 tasks done
Glavin001 opened this issue Feb 19, 2014 · 5 comments
Closed
7 tasks done

Complete support for REST API #2

Glavin001 opened this issue Feb 19, 2014 · 5 comments
Assignees

Comments

@Glavin001
Copy link
Contributor

Service's Operations:

  • find
  • get
  • create
  • update
  • remove

Misc:

  • Support handling docs attribute to the service object.
  • Separate the services into separate Swagger API requests. Analogous to how http://swagger.wordnik.com/ works.
@Glavin001 Glavin001 self-assigned this Feb 19, 2014
@Glavin001
Copy link
Contributor Author

@daffl, what do you think of feathers-swagger so far for documentation? It's not yet completely usable, but what do you think of the concept itself.

@daffl
Copy link
Member

daffl commented Feb 20, 2014

Nice! I really like it. Looks like it already generates the basic documentation, so I think it could use something like Dox to parse the comments from a service file and set the Swagger options accordingly.

@Glavin001
Copy link
Contributor Author

+1 for Dox support! Although, I want to make it documentation in the code as much as possible... maybe it could read the file with Dox and then pipe the Dox output back into the docs parameter of the service? I'll have to think more about this.

I was thinking of adding documentation generation to feathers-mongoose-service, because it already has the schemas. And I was going to access docs key in the service object as the way to customize Swagger API documentation for a service (description, and other such info).

@Glavin001
Copy link
Contributor Author

@daffl, I just released version 0.2.0, which should pretty much support everything (for REST API) and allow complete freedom and usage of the Swagger API via the docs key of a service.

Let me know if you think this is release quality enough to be moved into the Feathers organization, if you'd like.

@daffl
Copy link
Member

daffl commented Feb 20, 2014

For a first version this is great. You're more than welcome to move it. I can look into the documentation parsing later.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants