API Documentation Client Generation (Swagger)

API Documentation Client Generation (Swagger)

Posted by: gnewtzie on 6 September 2018, 4:10 am EST

• 

  gnewtzie

  • Post Options:
  • Link
    Copy
  • Jump To Answer

  Posted 6 September 2018, 4:10 am EST

  I’ve tried taking the json returned from your swagger.json file

  http://help.grapecity.com/activereports/webhelp/AR12ServerAPI/spec/rest_api.json

  and generating a c# client off of it but the format of the file isn’t compatible. Is it possible to get that file to be in a correct file format so a client can be generated automatically using something like NSwagStudio or Swagger Editor. It would make generating a client trivial for integrations.

• 

  mohitg

  

  • Post Options:
  • Link
    Copy

  Posted 6 September 2018, 5:52 pm EST

  Hello,

  Could you please explain your requirement. Why you need this Json file. We already have the documentation for Rest API. You can use that to share the information with your customer.

  http://help.grapecity.com/activereports/webhelp/AR12ServerAPI/index.html

  Thanks,

• 

  gnewtzie

  • Post Options:
  • Link
    Copy

  Posted 25 September 2018, 1:45 am EST

  I’m doing an integration with Active Reports and need to use the API to create Datasources, Datasets, etc. from our application. It would be much easier to integrate if the swagger.json file (which rest_api.json is created as) could be imported into NSwagStudio and have it generate the client for me. This would save a lot of time and could be autogenerated as the api changes due to version upgrades and service packs.

• 

  mohitg

  

  • Post Options:
  • Link
    Copy

  Posted 25 September 2018, 9:11 pm EST

  Hello,

  I have escalated the issue to our development team(ID 264539) and will inform you once I get any information from them.

  Thanks,

• 

  mohitg

  

  • Post Options:
  • Link
    Copy

  Posted 26 September 2018, 10:48 pm EST

  Hello,

  Swagger is only used for documenting ARS rest API at our website. Also, we do not have plans to make the resulted json compatible with the code generation tools in the near future.

  Sorry for the inconvenience caused.

  Thanks,