/api

Moov API documentation

Primary LanguageGoApache License 2.0Apache-2.0

api.moov.io

Build Status Apache 2 licensed

This repository holds our api.moov.io website, which is our hosted API service and documentation. Documentation is markdown generated by ReDoc. View source on the Swagger Editor.

Mocked Values

You can use the stoplightio/prism CLI to mock API responses from our OpenAPI specification.

To install with npm run the following: npm install -g @stoplight/prism-cli.

Then start their server and start calling endpoints.

Static values

prism mock https://raw.githubusercontent.com/moov-io/api/master/openapi.yaml

Dynamic values

prism mock -d https://raw.githubusercontent.com/moov-io/api/master/openapi.yaml

Getting Help

channel info
Google Group moov-users The Moov users Google group is for contributors other people contributing to the Moov project. You can join them without a google account by sending an email to moov-users+subscribe@googlegroups.com. After receiving the join-request message, you can simply reply to that to confirm the subscription.
Twitter @moov_io You can follow Moov.IO's Twitter feed to get updates on our project(s). You can also tweet us questions or just share blogs or stories.
GitHub Issue If you are able to reproduce a problem please open a GitHub Issue under the specific project that caused the error.
moov-io slack Join our slack channel to have an interactive discussion about the development of the project.

Contributing

Yes please! Please start by reviewing our Code of Conduct.

You only have a fresh set of eyes once! The easiest way to contribute is to give feedback on the documentation that you are reading right now. This can be as simple as sending a message to our Google Group with your feedback or updating the markdown in this documentation and issuing a pull request.

License

Apache License 2.0 See LICENSE for details.