sanic-api

v0.2.9

Sanic 框架实用API工具集，拥有自动生成文档、参数校验、配置的导入、日志功能的优化等功能，更好的助力接口的开发 For more information about how to use this package see README

Latest version published 10 months ago

License: MIT

PyPI

GitHub

Package Health Score

76 / 100

security
No known security issues
popularity
Small
maintenance
Sustainable
community
Active

Popularity

Small

GitHub Stars: 39.14K
Forks: 2.47K
Contributors: 440

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package sanic-api, we found that it has been starred 39,140 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Feb 1, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

Yes

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Sustainable

Commit Frequency

Open Issues: 361
Open PR: 32
Last Release: 10 months ago
Last Commit: 8 days ago

Further analysis of the maintenance status of sanic-api based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that sanic-api demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

Readme: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 440
Funding: No

A good and healthy external contribution signal for sanic-api project, which invites more than one hundred open source maintainers to collaborate on the repository.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.8,<3.12

Age: 2 years
Latest Release: 5 days ago
Dependencies: 0 Direct
Versions: 11
Maintainers: 1
Wheels: OS Independent

Readme

logo

Sanic-API

让您的sanic服务程序更好的支持API文档、参数校验、日志打印、响应规范等

特性

无需任何多余改动，全自动生成openapi文档，使用更加方便
基于pydantic的参数校验器，让接口的请求及响应更符合你的预期
使用loguru库代替官方logging日志库，并对访问日志进行扩展，支持打印接口耗时、接口参数
使用{code: 0, data: null, msg: ""}样式的接口返回
对接口中的异常进行拦截，及自定义错误码
接口返回样式可自定义配置

截图

路线图

增加一键生成预设项目cli命令
编写详细文档
API接口增加请求头、URL路径参数收集和校验:

安装

使用 pip 安装 sanic-api

  pip install sanic-api

使用方法/示例

from sanic import Sanic, text
from sanic_api import init_api

app = Sanic("Sanic-API")


@app.get('/')
async def index(request):
    return text("Sanic-API Example")


def main():
    init_api(app)
    app.run(access_log=True)


if __name__ == '__main__':
    main()

开发

要部署这个项目，请运行

  pip install pdm
  pdm sync

文档

FAQs

What is sanic-api?

Sanic 框架实用API工具集，拥有自动生成文档、参数校验、配置的导入、日志功能的优化等功能，更好的助力接口的开发. Visit Snyk Advisor to see a full health score report for sanic-api, including popularity, security, maintenance & community analysis.

Is sanic-api popular?

The python package sanic-api receives a total of 118 weekly downloads. As such, sanic-api popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is sanic-api well maintained?

We found indications that sanic-api maintenance is sustainable demonstrating some project activity. We saw a total of 440 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is sanic-api safe to use?

The python package sanic-api was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 18 November-2024, at 22:27 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP