Skip to content

IkoAfianando/openapi-todolist-javascript-client

Repository files navigation

todolist_restful_api

TodolistResTfulApi - JavaScript client for todolist_res_tful_api OpenAPI for Todolist RESTful API This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1
  • Package version: 1
  • Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen For more information, please visit https://github.com/IkoAfianando

Installation

npm

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

Then install it via:

npm install todolist_res_tful_api --save

git

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

    npm install GIT_USER_ID/GIT_REPO_ID --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):

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 TodolistResTfulApi = require('todolist_res_tful_api');
var defaultClient = TodolistResTfulApi.ApiClient.instance;

// Configure API key authorization: TodolistAuth
var TodolistAuth = defaultClient.authentications['TodolistAuth'];
TodolistAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//TodolistAuth.apiKeyPrefix['X-API-Key'] = "Token"

var api = new TodolistResTfulApi.TodolistApi()
var opts = { 
  'includeDone': false, // {Boolean} Include done todolist in the result
  'name': "name_example" // {String} Filter todolist by name
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.todolistGet(opts, callback);

Documentation for API Endpoints

All URIs are relative to https://{environment}.programmingwithiko.com/api/v1

Class Method HTTP request Description
TodolistResTfulApi.TodolistApi todolistGet GET /todolist Get All Todolist
TodolistResTfulApi.TodolistApi todolistPost POST /todolist Create New Todolist
TodolistResTfulApi.TodolistApi todollistTodolistIdDelete DELETE /todollist/{todolistId} Delete existing Todolist
TodolistResTfulApi.TodolistApi todollistTodolistIdPut PUT /todollist/{todolistId} Update existing Todolist

Documentation for Models

Documentation for Authorization

TodolistAuth

  • Type: API key
  • API key parameter name: X-API-Key
  • Location: HTTP header

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published