Skip to content

馃寬Example swagger client for angular (using nodejs). Generate AngularJS 1.x services from swagger.json

Notifications You must be signed in to change notification settings

CayetanoHerreraLuisRicardo/swagger-angularjs-client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

History

15 Commits

Repository files navigation

swagger-angularjs-client

###Example swagger client for angular (using nodejs)

ANTES DE EMPEZAR TIENES QUE TENER INSTALADO nodejs Y npm

2.- CREA LA DOCUMENTACION DE TU API EN EL EDITOR DE SWAGGER (para documentar tu API apoyate de la especificaci贸n 'OpenAPI Specification' https://swagger.io/specification y de este ejemplo https://github.com/OAI/OpenAPI-Specification/blob/master/examples/v2.0/yaml/uber.yaml), LOS FORMATOS QUE MANEJA SWAGGER SON 'YAML' Y 'JSON'

3.- EN LA CARPETA DEL PROYECTO (A脷N VACIA) EJECUTA 'npm init -y' E INSTALA LA DEPENDENCIA swagger-js-codegen 'npm install swagger-js-codegen --save' QUIEN NOS AYUDAR脕 A GENERAR NUESTRO CLIENTE (para mas info 'https://github.com/wcandillon/swagger-js-codegen')

result firebug

4.- CREA TU ARCHIVO .js EN MI CASO LLAMADO "app.js" CON LAS SIGUIENTES LINEAS DE C脫DIGO

////////INICIO//////////
//m贸dulo para manipulaci贸n de archivos
var fs = require('fs');
//m贸dulo para generar el cliente js
var CodeGen = require('swagger-js-codegen').CodeGen;
//https://github.com/wcandillon/swagger-js-codegen

//archivo .json generado desde el editor de swagger
var fileJSON = 'swagger/swaggerUber.json';
//http://editor.swagger.io/

var swagger = JSON.parse(fs.readFileSync(fileJSON, 'UTF-8'));
//elegimos generar el cliente para angularjs
var angularjsSourceCode = CodeGen.getAngularCode({ className: 'clientSwagger', swagger: swagger });

//nombre del archivo donde se guardar谩 el cliente angularjs generado
var dirAjs = './clientAngularSwagger.js';

//funci贸n que crea o sobre-escribe en el archivo
function generaAngularJS(file,client){
	fs.exists(file, function(res) {
		if(res)
			fs.writeFile(file, client, function(err) {
				if( err ){
					console.log(err);
				}
				else{
					console.log('Se sobre-escribi贸 y gener贸 el archivo '+file);
				}
			});
		else{
			var wstream = fs.createWriteStream(file);
			wstream.write(client)
			wstream.end(function () {
				console.log('archivo creado y generado '+file); 
			});
		}
	});	
}
generaAngularJS(dirAjs,angularjsSourceCode);
////////FIN//////////

5.- UNA VEZ CREADA LA DOCUMENTACI脫N DE TU API DESDE EL EDITOR DEL SWAGGER, LO DESCARGAMOS EN FORMATO JSON, CREAMOS UNA CARPETA EN MI CASO 'swagger' Y PEGAMOS EL ARCHIVOS JSON Y LE PONES EL NOMBRE QUE GUSTES EN MI CASO 'swaggerUber.json'

NOTA: SI QUIERES OMITIR ESTE PUNTO AQUI ESTA EL EJEMPLO DE UBER 'https://github.com/OAI/OpenAPI-Specification/blob/master/examples/v2.0/json/uber.json' ESTO PARA HACER TU PRUEBA Y GENERAR TU CLIENTE ANGULARJS

download in json format

6.- EJECUTAMOS EL SIGUIENTE COMANDO 'node app' EN LA RAIZ DEL PROYECTO

command

7.- LISTO SE GENER脫 NUESTRO CLIENTE PARA ANGULARJS

code-angular

file-js-angular

About

馃寬Example swagger client for angular (using nodejs). Generate AngularJS 1.x services from swagger.json

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published