1.0.1 • Published 2 years ago

api-swagger-js v1.0.1

Weekly downloads
-
License
ISC
Repository
github
Last release
2 years ago

my_api

MyApi - JavaScript client for my_api Documentation automatically generated by the swagger-autogen module. This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install my_api --save
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your my_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('my_api') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/my_api then install it via:

    npm install YOUR_USERNAME/my_api --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var MyApi = require('my_api');

var api = new MyApi.ClienteApi()

var cuit = "cuit_example"; // {String} cuit de la empresa.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.clienteCuitGet(cuit, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost:8081

ClassMethodHTTP requestDescription
MyApi.ClienteApiclienteCuitGetGET /cliente/{cuit}
MyApi.ClienteApiclienteGetGET /cliente/
MyApi.ClienteApiclientePostPOST /cliente/
MyApi.EmpleadoApiempleadoUsuarioGetGET /empleado/usuario
MyApi.EstadoApiestadoIdGetGET /estado/{id}
MyApi.EstadoApiestadoPutPUT /estado/
MyApi.EstadoApiestadoTipoEstadoGetGET /estado/tipoEstado
MyApi.OperarioApioperarioGetGET /operario/
MyApi.OperarioApioperarioIdGetGET /operario/{id}
MyApi.OperarioApioperarioOperarioSectorNombreSectorGetGET /operario/operarioSector/{nombreSector}
MyApi.OrdenApiordenCrearOrdenProduccionPostPOST /orden/crearOrdenProduccion
MyApi.OrdenApiordenGetGET /orden/
MyApi.OrdenApiordenIdGetGET /orden/{id}
MyApi.OrdenApiordenIdPatchPATCH /orden/{id}
MyApi.OtiApiotiActualizarOrdenPutPUT /oti/actualizarOrden
MyApi.OtiApiotiDatosBasicosPostPOST /oti/datosBasicos
MyApi.OtiApiotiGetGET /oti/
MyApi.OtiApiotiIdGetGET /oti/{id}
MyApi.OtiApiotiObtenerOrdenesFechaGetGET /oti/obtenerOrdenes/{fecha}
MyApi.OtiApiotiObtenerRoscasIdOrdenGetGET /oti/obtenerRoscas/{idOrden}
MyApi.OtiApiotiSectoresGetGET /oti/sectores
MyApi.OtiApiotiSectoresYTareasPutPUT /oti/sectoresYTareas
MyApi.RoscaApiroscaGetGET /rosca/
MyApi.RoscaApiroscaIdGetGET /rosca/{id}
MyApi.RoscaApiroscaPostPOST /rosca/
MyApi.RoscaApiroscaTipoDeRoscaGetGET /rosca/tipoDeRosca
MyApi.SectorApisectorGetGET /sector/
MyApi.SectorApisectorNombreGetGET /sector/{nombre}
MyApi.SupervisorApisupervisorGetGET /supervisor/
MyApi.SupervisorApisupervisorIdGetGET /supervisor/{id}
MyApi.TareaApitareaAsignarTareaPostPOST /tarea/asignarTarea
MyApi.TareaApitareaObtenerOtisNombreGetGET /tarea/obtenerOtis/{nombre}
MyApi.TareaApitareaObtenerTareasIdGetGET /tarea/obtenerTareas/{id}

Documentation for Models

Documentation for Authorization

api_key

  • Type: API key
  • API key parameter name: api_key
  • Location: HTTP header

petstore_auth