npm package: @jindodog/blog-client
Description: Client for blog api.
Latest version: 1.0.1

# @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](https://openapi-generator.tech) project:

- API version: 1.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install @jindodog/blog-client --save
```

Finally, you need to build the module:

```shell
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:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
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:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

Finally, you need to build the module:

```shell
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:

```shell
    npm install GIT_USER_ID/GIT_REPO_ID --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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):

```shell
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:

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

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
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**](docs/DefaultApi.md#login) | **GET** /login | Login
*BlogClient.DefaultApi* | [**logout**](docs/DefaultApi.md#logout) | **GET** /logout | Logout
*BlogClient.PostApi* | [**addUserPost**](docs/PostApi.md#addUserPost) | **POST** /users/{username}/posts | Create a new post
*BlogClient.PostApi* | [**getPost**](docs/PostApi.md#getPost) | **GET** /posts/{id} | Retreives a specific post
*BlogClient.PostApi* | [**getPostReplies**](docs/PostApi.md#getPostReplies) | **GET** /posts/{id}/replies | Retreive replies
*BlogClient.PostApi* | [**getPosts**](docs/PostApi.md#getPosts) | **GET** /posts | Retreives posts
*BlogClient.PostApi* | [**getReplyReplies**](docs/PostApi.md#getReplyReplies) | **GET** /replies/{id}/replies | Retreives replies
*BlogClient.PostApi* | [**getUserPosts**](docs/PostApi.md#getUserPosts) | **GET** /users/{username}/posts | Retreive posts by the user specified
*BlogClient.PostApi* | [**updateUserPost**](docs/PostApi.md#updateUserPost) | **PATCH** /users/{username}/posts/{id} | Update post
*BlogClient.ReplyApi* | [**addUserReply**](docs/ReplyApi.md#addUserReply) | **POST** /users/{username}/replies | Create a new reply
*BlogClient.ReplyApi* | [**getPostReplies**](docs/ReplyApi.md#getPostReplies) | **GET** /posts/{id}/replies | Retreive replies
*BlogClient.ReplyApi* | [**getReplies**](docs/ReplyApi.md#getReplies) | **GET** /replies | Retreves replies
*BlogClient.ReplyApi* | [**getReply**](docs/ReplyApi.md#getReply) | **GET** /replies/{id} | Retreive a specific reply
*BlogClient.ReplyApi* | [**getReplyReplies**](docs/ReplyApi.md#getReplyReplies) | **GET** /replies/{id}/replies | Retreives replies
*BlogClient.ReplyApi* | [**getUserReplies**](docs/ReplyApi.md#getUserReplies) | **GET** /users/{username}/replies | Retreive replies by specific user
*BlogClient.ReplyApi* | [**updateUserReply**](docs/ReplyApi.md#updateUserReply) | **PATCH** /users/{username}/replies/{id} | Updates a specific reply
*BlogClient.UserApi* | [**addUser**](docs/UserApi.md#addUser) | **POST** /users | Creates a new user
*BlogClient.UserApi* | [**addUserPost**](docs/UserApi.md#addUserPost) | **POST** /users/{username}/posts | Create a new post
*BlogClient.UserApi* | [**addUserReply**](docs/UserApi.md#addUserReply) | **POST** /users/{username}/replies | Create a new reply
*BlogClient.UserApi* | [**deleteUser**](docs/UserApi.md#deleteUser) | **DELETE** /users/{username} | Delete user
*BlogClient.UserApi* | [**getUser**](docs/UserApi.md#getUser) | **GET** /users/{username} | Retreives user information
*BlogClient.UserApi* | [**getUserPosts**](docs/UserApi.md#getUserPosts) | **GET** /users/{username}/posts | Retreive posts by the user specified
*BlogClient.UserApi* | [**getUserReplies**](docs/UserApi.md#getUserReplies) | **GET** /users/{username}/replies | Retreive replies by specific user
*BlogClient.UserApi* | [**updateUser**](docs/UserApi.md#updateUser) | **PATCH** /users/{username} | Updates user
*BlogClient.UserApi* | [**updateUserPost**](docs/UserApi.md#updateUserPost) | **PATCH** /users/{username}/posts/{id} | Update post
*BlogClient.UserApi* | [**updateUserReply**](docs/UserApi.md#updateUserReply) | **PATCH** /users/{username}/replies/{id} | Updates a specific reply


## Documentation for Models

 - [BlogClient.ApiError](docs/ApiError.md)
 - [BlogClient.NewPost](docs/NewPost.md)
 - [BlogClient.NewReply](docs/NewReply.md)
 - [BlogClient.NewUser](docs/NewUser.md)
 - [BlogClient.Post](docs/Post.md)
 - [BlogClient.Reply](docs/Reply.md)
 - [BlogClient.SubError](docs/SubError.md)
 - [BlogClient.UpdatePost](docs/UpdatePost.md)
 - [BlogClient.UpdateReply](docs/UpdateReply.md)
 - [BlogClient.UpdateUser](docs/UpdateUser.md)
 - [BlogClient.User](docs/User.md)


## Documentation for Authorization



### basicAuth


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