rbocchinfuso/cv-api

CV API

!alt text

![Language grade: Python]([] ![Total alerts]([] ![Quality Gate Status]([***]

镜像概述和主要用途

CV API是一个基于Python和Flask构建的简历（Curriculum Vitae）API服务，旨在通过RESTful接口提供简历数据的受控访问。用户可通过Bearer令牌认证获取JSON格式的简历数据，支持容器化部署，适用于个人简历数据的安全管理和程序化访问场景。

注意：如有任何问题或意见，可通过*** @rbocchinfuso联系我。

核心功能和特性

核心功能

• 基于JSON结构存储简历数据，遵循jsonresume.org标准
• 提供RESTful GET接口，支持通过Bearer令牌认证访问简历数据
• 容器化部署，包含nginx反向代理和cv-api应用容器
• 支持CI/CD流程，通过Docker Hub构建和Watchtower自动更新

技术架构

• 部署nginx容器，暴露80端口
• 构建cv-api应用容器（基于Python/Flask），暴露5000端口
• 通过nginx反向代理，使用虚拟主机名"cv.bocchinfuso.net"访问cv-api

开发与构建工具

• 规划工具：Evernote、Trello
• 平台环境：Ubuntu 18.04.3 LTS、Anaconda 3、Docker
• 开发工具：Codeanywhere（IDE）、autopep8、Postman、JSON Editor Online、StackEdit
• 版本控制：GitHub、DockerHub
• 构建工具：Docker Compose、Watchtower
• 测试工具：pytest、Post HTTP Request Online、Postman、lgtm、loader.io、sonarcloud
• 部署工具：Docker
• 监控工具：Prometheus and Grafana、Site24x7、Sentry、UptimeRobot、Logdna、Slack、***

使用场景和适用范围

• 个人简历数据的程序化访问和管理
• 学习API开发、容器化部署和CI/CD流程的实践案例
• 需要对简历访问进行控制和审计的场景
• 作为个人技术展示的API服务示例

详细使用方法和配置说明

前提要求

• https://github.com/pallets/flask
• https://github.com/miguelgrinberg/Flask-HTTPAuth
• ConfigParser

发送API请求

通过以下命令获取简历数据（需有效的Bearer令牌）：

bash
curl -H "Accept: application/json" -H "Authorization: Bearer Gj4TUbT209T0YEbmxwSZ9MgdC7AtRr6D" http://cv.bocchinfuso.net/app/api/v1.0/cv

• 在线运行CV API GET请求
• 查看完整API文档

本地获取镜像

bash
docker pull rbocchinfuso/cv-api

个人部署步骤

1. 获取源代码

   bash
   git clone https://github.com/rbocchinfuso/cv-api.git
   

   若未安装Git，可直接下载ZIP包：https://github.com/rbocchinfuso/cv-api/archive/master.zip

2. 修改配置

   • 编辑cv.json文件，更新为个人简历数据
   • （可选）修改config.ini文件，如更新认证令牌等配置

3. 构建和部署

   • 前台运行（附加模式）

     bash
     docker-compose up --build
     

   • 后台运行（分离模式）

     bash
     docker-compose up -d --build
     

贡献指南

1. Fork本项目
2. 创建特性分支：git checkout -b my-new-feature
3. 提交修改：git commit -am 'Add some feature'
4. 推送到分支：git push origin my-new-feature
5. 提交Pull Request

版本历史

• 0.1版（初始发布）- 2020/01/21
• 0.2版（更新readme.md）- 2020/02/15
• 0.3版（使用Mark重构演示代码）- 2020/06/10

作者信息

Rich Bocchinfuso <<***>>

许可证

MIT License

Copyright (c) [2020] [Richard J. Bocchinfuso]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.