├── .gitignore ├── .jshintrc ├── .travis.yml ├── Gruntfile.js ├── LICENSE ├── README.md ├── package.json └── tasks └── swagger-js-codegen.js /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | .DS_Store 3 | *.swp 4 | .idea 5 | -------------------------------------------------------------------------------- /.jshintrc: -------------------------------------------------------------------------------- 1 | { 2 | "node": true, 3 | "browser": false, 4 | "esnext": true, 5 | "bitwise": false, 6 | "camelcase": false, 7 | "curly": true, 8 | "eqeqeq": true, 9 | "immed": true, 10 | "indent": 4, 11 | "latedef": true, 12 | "newcap": false, 13 | "noarg": true, 14 | "quotmark": "single", 15 | "regexp": true, 16 | "undef": true, 17 | "unused": true, 18 | "strict": true, 19 | "trailing": true, 20 | "smarttabs": true, 21 | "globals": { 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: node_js 2 | node_js: 3 | - '0.11' 4 | - '0.10' 5 | before_script: 6 | - npm install -g grunt-cli 7 | deploy: 8 | provider: npm 9 | email: w@28.io 10 | api_key: 11 | secure: Awy+nueiNfDEU4wqUeH+4CQjnPC2d9yt53JOqPdf5yhb0ljuLDOa/k1pTM2C9dsmw11bVeQra5McHLrG9Aj5vl2+pDqFuxD6kBaF/CcLJBe3OztwwtrrM9Twgc/tXGozIs9zkXrEabHl0n26mMqGwozO2C4Uwj2h1S1+U2E6EzM= 12 | on: 13 | repo: wcandillon/grunt-swagger-js-codegen 14 | branch: master 15 | node: '0.11' 16 | -------------------------------------------------------------------------------- /Gruntfile.js: -------------------------------------------------------------------------------- 1 | module.exports = function (grunt) { 2 | 'use strict'; 3 | // Project configuration. 4 | grunt.initConfig({ 5 | jshint: { 6 | all: ['Gruntfile.js', 'tasks/**/*.js'], 7 | options: { 8 | jshintrc: '.jshintrc' 9 | } 10 | } 11 | }); 12 | 13 | // Load local tasks. 14 | grunt.loadTasks('tasks'); 15 | grunt.loadNpmTasks('grunt-contrib-jshint'); 16 | 17 | // Default task. 18 | grunt.registerTask('default', ['jshint']); 19 | }; 20 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | #Grunt Task for Swagger JS Codegen 2 | 3 | [![Build Status](https://travis-ci.org/wcandillon/grunt-swagger-js-codegen.svg?branch=master)](https://travis-ci.org/wcandillon/grunt-swagger-js-codegen) [![NPM version](http://img.shields.io/npm/v/grunt-swagger-js-codegen.svg?style=flat)](http://badge.fury.io/js/grunt-swagger-js-codegen) [![Code Climate](http://img.shields.io/codeclimate/github/wcandillon/grunt-swagger-js-codegen.svg?style=flat)](https://codeclimate.com/github/wcandillon/grunt-swagger-js-codegen) 4 | 5 | ##Examples 6 | ###Nodejs generation 7 | [See example.](https://github.com/28msec/28.io-nodejs/blob/master/Gruntfile.js#L11) 8 | ```javascript 9 | grunt.initConfig({ 10 | 'swagger-js-codegen': { 11 | queries: { 12 | options: { 13 | apis: [ 14 | { 15 | swagger: 'swagger/_queries', 16 | className: 'Model', 17 | moduleName: 'Model' // This is the model and file name 18 | } 19 | ], 20 | dest: 'lib' 21 | }, 22 | dist: { 23 | } 24 | } 25 | } 26 | }); 27 | ``` 28 | 29 | ###Angularjs generation 30 | [See example.](https://github.com/28msec/28.io-angularjs/blob/master/Gruntfile.js#L27) 31 | ```javascript 32 | grunt.initConfig({ 33 | 'swagger-js-codegen': { 34 | queries: { 35 | options: { 36 | apis: [ 37 | { 38 | swagger: 'swagger/_queries', 39 | className: 'Model', 40 | moduleName: 'Model', // This is the model and file name 41 | angularjs: true 42 | } 43 | ], 44 | dest: 'lib' 45 | }, 46 | dist: { 47 | } 48 | } 49 | } 50 | }); 51 | ``` 52 | 53 | ###Custom generation 54 | ```javascript 55 | grunt.initConfig({ 56 | 'swagger-js-codegen': { 57 | queries: { 58 | options: { 59 | apis: [ 60 | { 61 | swagger: 'swagger/_queries.json', 62 | moduleName: 'Model' // This is the file name 63 | className: 'Model', 64 | mustache: { 65 | moduleName: 'Model' // This is the model name - it should be repeated here if you want to use it in mustache templates 66 | customParam: 'foo' //some custom param used in mustache templates 67 | }, 68 | template: { 69 | class: 'custom-angular-class.mustache', 70 | method: 'custom-method.mustache', 71 | request: 'custom-angular-request.mustache' 72 | }, 73 | custom : true 74 | } 75 | ], 76 | dest: 'lib' 77 | }, 78 | dist: { 79 | } 80 | } 81 | } 82 | }); 83 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "grunt-swagger-js-codegen", 3 | "version": "0.4.6", 4 | "description": "Grunt task for Swagger JS codegen", 5 | "main": "./tasks/swagger-js-codegen.js", 6 | "scripts": { 7 | "test": "grunt" 8 | }, 9 | "bugs": { 10 | "url": "https://github.com/wcandillon/grunt-swagger-js-codegen/issues" 11 | }, 12 | "repository": { 13 | "type": "git", 14 | "url": "git://github.com/wcandillon/grunt-swagger-js-codegen.git" 15 | }, 16 | "keywords": [ 17 | "swagger", 18 | "rest", 19 | "dev", 20 | "cloud" 21 | ], 22 | "author": { 23 | "name": "William Candillon", 24 | "email": "w@28.io", 25 | "url": "http://28.io" 26 | }, 27 | "licenses": [ 28 | { 29 | "type": "Apache 2", 30 | "url": "https://github.com/wcandillon/grunt-swagger-js-codegen/blob/master/LICENSE" 31 | } 32 | ], 33 | "homepage": "https://github.com/wcandillon/grunt-swagger-js-codegen", 34 | "dependencies": { 35 | "lodash": "^2.4.1", 36 | "q": "^1.0.1", 37 | "request": "^2.45.0", 38 | "swagger-js-codegen": "1.1.8", 39 | "yamljs": "^0.2.7" 40 | }, 41 | "devDependencies": { 42 | "grunt": "~0.4.4", 43 | "grunt-contrib-jshint": "~0.9.2" 44 | } 45 | } 46 | -------------------------------------------------------------------------------- /tasks/swagger-js-codegen.js: -------------------------------------------------------------------------------- 1 | module.exports = function (grunt) { 2 | 'use strict'; 3 | var fs = require('fs'); 4 | var yaml = require('yamljs'); 5 | 6 | grunt.registerMultiTask('swagger-js-codegen', 'Swagger codegen for Javascript', function(){ 7 | var request = require('request'); 8 | var Q = require('q'); 9 | var _ = require('lodash'); 10 | 11 | var options = this.options(); 12 | var dest = options.dest; 13 | var promises = []; 14 | var done = this.async(); 15 | 16 | grunt.file.mkdir(dest); 17 | options.apis.forEach(function(api){ 18 | var deferred = Q.defer(); 19 | var fname = api.fileName || (api.moduleName || api.className) + '.js'; 20 | if(api.swagger.substring(0, 'http://'.length) === 'http://' || api.swagger.substring(0, 'https://'.length) === 'https://') { 21 | request({ 22 | uri: api.swagger, 23 | method: 'GET' 24 | }, function(error, response, body){ 25 | if(error || response.statusCode !== 200) { 26 | deferred.reject('Error while fetching ' + api.swagger + ': ' + (error || body)); 27 | } else { 28 | var swagger = JSON.parse(body); 29 | generateApi(api, swagger, dest, fname); 30 | deferred.resolve(); 31 | } 32 | }); 33 | } else if(testIfYamlExtension(api.swagger)) { 34 | fs.readFile(api.swagger, 'UTF-8', function(err, data) { 35 | if(err) { 36 | deferred.reject(err); 37 | } else { 38 | var swagger = yaml.parse(data); 39 | generateApi(api, swagger, dest, fname); 40 | deferred.resolve(); 41 | } 42 | }); 43 | } else { 44 | fs.readFile(api.swagger, 'UTF-8', function(err, data){ 45 | if(err) { 46 | deferred.reject(err); 47 | } else { 48 | var swagger = JSON.parse(data); 49 | generateApi(api, swagger, dest, fname); 50 | deferred.resolve(); 51 | } 52 | }); 53 | } 54 | promises.push(deferred.promise); 55 | }); 56 | Q.all(promises).then(function(){ 57 | done(); 58 | }).catch(function(error){ 59 | var e; 60 | if(_.isObject(error) && error.body) { 61 | e = JSON.stringify(error.body, null, 2); 62 | } else if(_.isObject(error)) { 63 | e = JSON.stringify(error, null, 2); 64 | } else if(error instanceof Error || _.isString(error)) { 65 | e = error; 66 | } else { 67 | e = new Error('Unknown error'); 68 | } 69 | grunt.fail.fatal(e); 70 | }); 71 | }); 72 | 73 | function testIfYamlExtension(filename) { 74 | return filename.substring(filename.length - '.yaml'.length).toLowerCase() === '.yaml' || filename.substring(filename.length - '.yml'.length).toLowerCase() === '.yml'; 75 | } 76 | 77 | function generateApi(api, swagger, dest, fname) { 78 | var CodeGen = require('swagger-js-codegen').CodeGen; 79 | var source = null; 80 | 81 | if (api.type === 'angular' || api.angularjs === true) { 82 | source = CodeGen.getAngularCode({ moduleName: api.moduleName, className: api.className, swagger: swagger }); 83 | } else if (api.custom === true) { 84 | source = CodeGen.getCustomCode({ className: api.className, swagger: swagger, mustache: api.mustache, 85 | template: { 86 | class: fs.readFileSync(api.template.class, 'utf-8'), 87 | method: fs.readFileSync(api.template.method, 'utf-8'), 88 | request: fs.readFileSync(api.template.request, 'utf-8') 89 | } 90 | }); 91 | } else { 92 | source = CodeGen.getNodeCode({ className: api.className, swagger: swagger }); 93 | } 94 | grunt.log.writeln('Generated ' + fname + ' from ' + api.swagger); 95 | fs.writeFileSync(dest + '/' + fname, source, 'UTF-8'); 96 | } 97 | }; 98 | --------------------------------------------------------------------------------