Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Privacy
    • Imprint
    • Contact
    • Login methods
  • Sign in
  • ARSnova Backend ARSnova Backend
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 27
    • Issues 27
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 1
    • Merge requests 1
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • ARSnovaARSnova
  • ARSnova BackendARSnova Backend
  • Merge requests
  • !4

Implemented and documented interactive API documentation with Springfox

  • Review changes

  • Download
  • Email patches
  • Plain diff
Closed Tjark Wilhelm Hoeck requested to merge twhc55/arsnova-backend:swagger_api into master Jun 08, 2015
  • Overview 1
  • Commits 1
  • Pipelines 0
  • Changes

This feature supports developers with an interactive documentation of the REST API from the ARSnova Backend.

The SpringFox framework takes care of the automatically build, everytime up-to-date documentation. SpringFox uses Swagger-Core and Swagger UI and is optimizing those frameworks for supporting REST endpoints build with Spring MVC.

Futhermore, the REST API developers should mention, that SpringFox needs several Annotations for displaying the right informations for the endpoints. Please notice our developer documentation in the ARSnova-Wiki.

Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: swagger_api