education_manage_api/README.md

EducationManageApi - JavaScript client for education_manage_api 教务管理，包括学生信息，成绩管理 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

# education_manage_api

EducationManageApi - JavaScript client for education_manage_api
教务管理，包括学生信息，成绩管理 
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 1.0.0
- Package version: 1.0.0
- Build package: class io.swagger.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 education_manage_api --save
```

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

```shell
    npm install YOUR_USERNAME/education_manage_api --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.

## Getting Started

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

```javascript
var EducationManageApi = require('education_manage_api');

var defaultClient = EducationManageApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: education_auth
var education_auth = defaultClient.authentications['education_auth'];
education_auth.accessToken = "YOUR ACCESS TOKEN"

var api = new EducationManageApi.StudentsApi()

var id = "id_example"; // {String} 

var apiKey = "apiKey_example"; // {String} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.studentsIdDelete(id, apiKey, callback);

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*EducationManageApi.StudentsApi* | [**studentsIdDelete**](docs/StudentsApi.md#studentsIdDelete) | **DELETE** /students/{id} | delete student info
*EducationManageApi.StudentsApi* | [**studentsIdGet**](docs/StudentsApi.md#studentsIdGet) | **GET** /students/{id} | get student info
*EducationManageApi.StudentsApi* | [**studentsIdPut**](docs/StudentsApi.md#studentsIdPut) | **PUT** /students/{id} | update student info
*EducationManageApi.StudentsApi* | [**studentsLoginPost**](docs/StudentsApi.md#studentsLoginPost) | **POST** /students/login | student login
*EducationManageApi.StudentsApi* | [**studentsRegistePost**](docs/StudentsApi.md#studentsRegistePost) | **POST** /students/registe | student registe


## Documentation for Models

 - [EducationManageApi.InlineResponse200](docs/InlineResponse200.md)
 - [EducationManageApi.InlineResponse401](docs/InlineResponse401.md)
 - [EducationManageApi.Student](docs/Student.md)


## Documentation for Authorization


### api_key

- **Type**: API key
- **API key parameter name**: api_Key
- **Location**: HTTP header

### education_auth

- **Type**: OAuth
- **Flow**: implicit
- **Authorization URL**: http://test.swagger/api/oaurh/dialog
- **Scopes**: 
  - write_students: modify student in your accoutn
  - read_students: read you message