Merge pull request #243 from akeneo/swagger-json

Generate Swagger JSON specification

Author: ahocquard

content/swagger/akeneo-web-api.json

@@ -36,3 +36,8 @@ npm serve
 
 The API documentation site is then available on `localhost:8000`.
 Files located in the content and src directories are watched for changes, so when developing you do not need to launch any other task.
+
+## Swagger
+
+As our YAML Swagger spec uses references and links, it is considered as non-valid.
+During the build, we generate a valid JSON specification that is put under the `content/swagger` folder. Don't forget to version it if you made any change into the YAML Swagger spec.

readme.md

@@ -90,7 +90,7 @@
                     </div>
                     <div class="col-sm-4">
                         <div class="panel panel-default panel-btn">
-                            <a href="https://github.com/akeneo/pim-api-docs/blob/master/content/swagger/akeneo-web-api.yaml">
+                            <a href="https://github.com/akeneo/pim-api-docs/blob/master/content/swagger/akeneo-web-api.json">
                                 <div class="panel-body">
                                     <div class="row">
                                         <div class="col-xs-offset-4 col-xs-4 col-sm-offset-2 col-sm-8 col-md-offset-3 col-md-6">

src/index.handlebars

@@ -101,6 +101,7 @@ gulp.task('reference', ['clean-dist', 'less'], function() {
 
         gulp.src('./content/swagger/akeneo-web-api.yaml')
             .pipe(swagger('akeneo-web-api.json'))
+            .pipe(gulp.dest('content/swagger'))
             .pipe(jsonTransform(function(data, file) {
                 var templateData = data;
                 data.categories = {};