Project

General

Profile

Feature #23898

Updated by Patrick Seidensal almost 6 years ago

Currently we already have a browsable API implementation, useful for development propose. 

 You can try it by accessing: 

 <pre> 
   

   http://<CEPH_DASHBOARD_HOST>:<CEPH_DASHBOARD_PORT>/api/block/image 
 </pre> 

 But the current implementation requires the interception of all HTTP request, even on production environment. 

 An alternative approach would be to collect all the information during module load time, avoiding the interception of all HTTP requests, and use some external tool to document the API. 


 We should consider using a tool like https://swagger.io/ that uses a specification file to generaet the documentation: 

 <pre> 
   

   https://editor.swagger.io//?_ga=2.88673627.1361634586.1524820439-533980631.1524820439#/ 
 </pre> 


Back