search

fsbahman / apidoc-swagger

apidoc and swagger are two nice projects which are focusing on documentation of APIs. This project is a middle tier which tries to bring them together in a sense that it uses apidoc to convert inline documentation to json schema and later convert it to swagger json schmea.
Other
251 stars 129 forks source link

Upgraded Dependencies and made compatible with Swagger 2.0 #50

Closed direwolf2494 closed 4 years ago

direwolf2494 commented 4 years ago

I've added the following changes

  1. Added additional cli options to allow users to added additional parameters required by swagger ui
    • readme updated to reflect this
  2. Updated outdated decencies (nomnom is still being used instead of commander though)
    • Some logic needed updating (eg. some lodash functions)
  3. Updated to work with Swagger 2.0
    • Headers are now being found
    • Path parameters are now included in the parameter list correctly
    • Body parameters are now correctly found
    • body definitions types are now correct when the type is an array of any type
    • added option to default responses to generic object (some generate responses cause errors on swagger ui)
    • added additional swagger attributes (base path, schemes, host)