@jindodog/blog-client NPM

@jindodog/blog-client

BlogClient - JavaScript client for @jindodog/blog-client This is a simple blog api. This SDK is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
Package version: 1.0.0
Build package: org.openapitools.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 @jindodog/blog-client --save

Finally, you need to build the module:

npm run build

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

To use the link you just defined in your project, switch to the directory you want to use your @jindodog/blog-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

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 BlogClient = require('@jindodog/blog-client');


var api = new BlogClient.DefaultApi()
var authorization = "authorization_example"; // {String} 
api.login(authorization).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to http://localhost:8080/api/v1

Class	Method	HTTP request	Description
BlogClient.DefaultApi	login	GET /login	Login
BlogClient.DefaultApi	logout	GET /logout	Logout
BlogClient.PostApi	addUserPost	POST /users/{username}/posts	Create a new post
BlogClient.PostApi	getPost	GET /posts/{id}	Retreives a specific post
BlogClient.PostApi	getPostReplies	GET /posts/{id}/replies	Retreive replies
BlogClient.PostApi	getPosts	GET /posts	Retreives posts
BlogClient.PostApi	getReplyReplies	GET /replies/{id}/replies	Retreives replies
BlogClient.PostApi	getUserPosts	GET /users/{username}/posts	Retreive posts by the user specified
BlogClient.PostApi	updateUserPost	PATCH /users/{username}/posts/{id}	Update post
BlogClient.ReplyApi	addUserReply	POST /users/{username}/replies	Create a new reply
BlogClient.ReplyApi	getPostReplies	GET /posts/{id}/replies	Retreive replies
BlogClient.ReplyApi	getReplies	GET /replies	Retreves replies
BlogClient.ReplyApi	getReply	GET /replies/{id}	Retreive a specific reply
BlogClient.ReplyApi	getReplyReplies	GET /replies/{id}/replies	Retreives replies
BlogClient.ReplyApi	getUserReplies	GET /users/{username}/replies	Retreive replies by specific user
BlogClient.ReplyApi	updateUserReply	PATCH /users/{username}/replies/{id}	Updates a specific reply
BlogClient.UserApi	addUser	POST /users	Creates a new user
BlogClient.UserApi	addUserPost	POST /users/{username}/posts	Create a new post
BlogClient.UserApi	addUserReply	POST /users/{username}/replies	Create a new reply
BlogClient.UserApi	deleteUser	DELETE /users/{username}	Delete user
BlogClient.UserApi	getUser	GET /users/{username}	Retreives user information
BlogClient.UserApi	getUserPosts	GET /users/{username}/posts	Retreive posts by the user specified
BlogClient.UserApi	getUserReplies	GET /users/{username}/replies	Retreive replies by specific user
BlogClient.UserApi	updateUser	PATCH /users/{username}	Updates user
BlogClient.UserApi	updateUserPost	PATCH /users/{username}/posts/{id}	Update post
BlogClient.UserApi	updateUserReply	PATCH /users/{username}/replies/{id}	Updates a specific reply

Documentation for Models

Documentation for Authorization

basicAuth

Type: API key
API key parameter name: JSESSIONID
Location:

@babel/cli superagent

@infinitebrahmanuniverse/nolb-_jin @everything-registry/sub-chunk-489 @zalastax/nolb-_jin

1.0.1

4 years ago

1.0.0

4 years ago