fdubbsmobile / rest-api-doc

This repository contains the documentation and JSON schema specification for Fudan BBS.

Documentation

Please see the domain model and human description of the specification here.

The release note of the initial v1 implementation can be found here.

The user guide for clients of services implementing this spec can be found here.

Schema

The JSON Schema can be found here. The Google Discovery Document for the service is here.

The maven artifact for this specification can be found here.

Which Branch to use?

Please use the develop branch to make changes as required during the specification/development phase.

Once the spec is final, create a new branch release-x.x from the develop branch. When the release-x.x goes live, merge the changes with the master.

The master always contains the last released API specification that's in live.