https://github.com/xuxueli/xxl-api

A api management platform.（API管理平台XXL-API）
https://github.com/xuxueli/xxl-api

api document java xxl xxl-api

Last synced: 5 days ago
JSON representation

A api management platform.（API管理平台XXL-API）

• Host: GitHub
• URL: https://github.com/xuxueli/xxl-api
• Owner: xuxueli
• License: gpl-3.0
• Created: 2017-03-29T09:49:31.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-11-16T11:47:02.000Z (about 1 month ago)
• Last Synced: 2024-12-13T00:02:37.556Z (12 days ago)
• Topics: api, document, java, xxl, xxl-api
• Language: Java
• Homepage: http://www.xuxueli.com/xxl-api/
• Size: 4.31 MB
• Stars: 910
• Watchers: 74
• Forks: 413
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    

    
XXL-API

    


        XXL-API, a api management platform.

        


        -- Home Page --

        


        


        

            

        

        

         

        

        

            

        

        

            

        

        

         

        

        

           

        

    
    


## Introduction

XXL-API is an API management platform that is easy to learn and use, simple and efficient, and powerful in functionality.

It serves multiple roles, including product, front-end and back-end development, and testing, and provides one-stop capabilities such as API management, Mock, and testing.

XXL-API 是一个API管理平台，易学易用、简单高效且功能强大，服务于产品、前后端研发及测试等多角色人员，提供API管理、Mock、测试等一站式能力。

## Documentation

- [中文文档](https://www.xuxueli.com/xxl-api/)

## Communication    

- [社区交流](https://www.xuxueli.com/page/community.html)

## Features

- 1、易学易用：功能实用、交互简洁，三分钟上手；

- 2、容器化：提供官方docker镜像，并实时更新推送dockerhub，进一步实现产品开箱即用；

- 3、项目隔离：支持以项目维度进行API隔离管控；

- 4、分组管理：针对单个项目中API，支持自定义分组进行管理；

- 5、权限控制：支持以业务线为维度进行用户权限控制，分配权限才允许操作业务线下项目接口和数据类型，保障API数据安全；

- 6、API Mock：内置MockServer，支持为API灵活定义Mock数据并定制数据响应格式，从而快速提供Mock接口、加快开发进度；

- 7、API 测试：支持针对API进行在线测试，且支持定义管理测试数据，提升接口测试效率；

- 8、API 管理：支持创建、更新和删除API；

- 9、属性丰富：支持丰富的API属性设置，包括API状态、请求方法、请求URL、请求头部、请求参数、响应结果、响应结果格式、响应结果参数、API备注等；

- 10、星级标记：支持API星级标注，标记后优先提权展示；

- 11、Markdown：支持为API添加Markdown格式的备注信息；

## Contributing

Contributions are welcome! Open a pull request to fix a bug, or open an [Issue](https://github.com/xuxueli/xxl-api/issues/) to discuss a new feature or change.

欢迎参与项目贡献！比如提交PR修复一个bug，或者新建 [Issue](https://github.com/xuxueli/xxl-api/issues/) 讨论新特性或者变更。

## 接入登记

更多接入的公司，欢迎在 [登记地址](https://github.com/xuxueli/xxl-api/issues/1 ) 登记，登记仅仅为了产品推广。

## Copyright and License

This product is open source and free, and will continue to provide free community technical support. Individual or enterprise users are free to access and use.

- Licensed under the GNU General Public License (GPL) v3.

- Copyright (c) 2015-present, xuxueli.

产品开源免费，并且将持续提供免费的社区技术支持。个人或企业内部可自由的接入和使用。

## Donate

No matter how much the amount is enough to express your thought, thank you very much ：）     [To donate](https://www.xuxueli.com/page/donate.html )

无论金额多少都足够表达您这份心意，非常感谢 ：）      [前往捐赠](https://www.xuxueli.com/page/donate.html )