Skip to content

Idea: Add a guide for designing and developing JSON APIs #364

Closed

Description

@malandrina

For context: This idea came out of the discussion on https://github.com/thoughtbot/robots.thoughtbot.com/pull/868.

We build a lot of JSON APIs at thoughtbot. We could be doing a better job of documenting the patterns, tooling, and specifications we've found work well for us.

What do folks think of adding a guide for designing and developing JSON APIs to best-practices?

Activity

  1. jferris commented on Oct 21, 2015

    @jferris
    Contributor

    I'm not opposed to having a JSON best practices guide, but it's hard to know if it would be helpful without actually seeing it. I think the next best step would be to put together a very rough draft and open a pull request.

  2. jessieay commented on Oct 21, 2015

    @jessieay
    Contributor

    I think this is a great idea.

    iOS on Rails focuses more on the practical aspects of developing a JSON API w Rails, but there might be some stuff you can pull from that.

  3. self-assigned this
    on Oct 21, 2015
  4. malandrina commented on Oct 21, 2015

    @malandrina
    Author

    Cool! PR opened: #365.

  5. malandrina commented on Jan 11, 2016

    @malandrina
    Author

    Closing this issue now that #365 is merged.

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

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions