Project

General

Profile

Actions
Copy link

Task #506

closed

Swagger rest api documentation

Added by Radek Tomiška almost 7 years ago. Updated almost 7 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Radek Tomiška
Category:
Rest
Target version:
Citrine (7.3.0)
Start date:
06/13/2017
Due date:
% Done:

100%

Estimated time:
Owner:

Description

Integrate swagger rest api documentation. This doc will be linkedn from https://wiki.czechidm.com/.

Actions
Copy link
 #1

Updated by Radek Tomiška almost 7 years ago

  • % Done changed from 0 to 30

I've integrated swagger-ui and continue with swagger2markup for static documentation generation (html, pdf).

Actions
Copy link
 #2

Updated by Radek Tomiška almost 7 years ago

  • Target version set to Citrine (7.3.0)
  • % Done changed from 30 to 50

I've configured swagger documentation for modules: core, acc, example
Doc: https://wiki.czechidm.com/7.3/dev/swagger

I continue with adding other endpoints in core and acc module

Actions
Copy link
 #3

Updated by Radek Tomiška almost 7 years ago

  • Status changed from In Progress to Needs feedback
  • Assignee changed from Radek Tomiška to Vít Švanda
  • % Done changed from 50 to 90

I've included static documentation directly in .jar module package. Links to documentation were added to FE modules content. I've added api reference section from wiki to asciidoc.
Doc: https://wiki.czechidm.com/7.3/dev/architecture/swagger

Could you pls do a test and review?

Actions
Copy link
 #4

Updated by Vít Švanda almost 7 years ago

  • Status changed from Needs feedback to Closed
  • Assignee changed from Vít Švanda to Radek Tomiška
  • % Done changed from 90 to 100

I did review, works and looks nice.

Actions
Copy link

Also available in: Atom PDF