# AndServer

**Repository Path**: ZL007/AndServer

## Basic Information

- **Project Name**: AndServer
- **Description**: :cherries: Web server and web framework of Android platform.
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-03-27
- **Last Updated**: 2022-05-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# AndServer

![Logo](./images/logo.svg)

Web server and Web framework of Android platform. It provides annotations like SpringMVC, and if you are familiar with SpringMVC, you can master it very quickly.

- Static html website deployment
- Dynamic http api deployment

```java
@RestController
@RequestMapping(path = "/user")
public class UserController {

    @PostMapping("/login")
    public String login(
        @RequestParam("account") String account,
        @RequestParam("password") String password) {

        ...
        return "Successful.";
    }

    @GetMapping(path = "/{userId}")
    public User info(
        @PathVariable("userId") String userId,
        @QueryParam("fields", required = false) String fields) {

        User user = findUserById(userId, fields);
        ...

        return user;
    }

    @PutMapping(path = "/{userId}")
    public void modify(
        @PathVariable("userId") String userId
        @RequestParam("age") int age) {
        ...
    }
}
```

The above code will generate the following two http apis:

```text
POST http://.../user/login
GET http://.../user/uid_001?fields=id,name,age
PUT http://.../user/uid_001
```

For documentation and additional information see [the website](https://www.yanzhenjie.com/AndServer).

## Download

```groovy
dependencies {
    implementation 'com.yanzhenjie.andserver:api:2.0.5'
    annotationProcessor 'com.yanzhenjie.andserver:processor:2.0.5'
}
```

If you are using Kotlin, replace `annotationProcessor` with `kapt`.

AndServer requires at minimum Android 2.3(Api level 9).

## Contributing

Before submitting pull requests, contributors must abide by the [agreement](./CONTRIBUTING.md) .

## License

```text
Copyright 2019 Zhenjie Yan

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```