【web项目 搭建环境&接口模块开发 02】
一、前后端分离概念
二、搭建项目后端环境
项目模块构建
数据库创建表结构+初始化数据
导入sql:资料/sql/*.sql
=========>医院挂号平台开发项目<==============
三、医院模块开发需求
1、需求:
医院设置主要是用来保存开通医院的一些基本信息,每个医院一条信息,保存了医院编号(平台分配,全局唯一)和接口调用相关的签名key等信息,是整个流程的第一步,只有开通了医院设置信息,才可以上传医院相关信息。
我们所开发的功能就是基于单表的一个CRUD、锁定/解锁和发送签名信息这些基本功能。
2、表结构
hosname:医院名称 hoscode:医院编号(平台分配,全局唯一,api接口必填信息) api_url:医院回调的基础url(如:预约下单,我们要调用该地址去医院下单) sign_key:双方api接口调用的签名key,有平台生成 contacts_name:医院联系人姓名 contacts_phone:医院联系人手机 status:状态(锁定/解锁)
四、医院模块开发
1、搭建医院模块 service-hosp
1.1、修改Pom文件,并添加application.properties文件配置信息
1.2、添加启动类:ServiceHospApplication
1.3、创建三层目录controller、service、mapper
到此为止整个service-hosp的整体目录结构已经创建完成,下面就是对这个模块进行增删改查操作
2、添加医院设置CURD -->即:完成model、mapper、service、controller的代码
完成CURD一般开发顺序为:model-->mapper-->service-->controller
五、Swagger2介绍与集成
什么是swagger2
编写和维护接口文档是每个程序员的职责,根据Swagger2可以快速帮助我们编写最新的API接口文档,再也不用担心开会前仍忙于整理各种资料了,间接提升了团队开发的沟通效率。
# 常用注解
swagger通过注解表明该接口会生成文档,包括接口名、请求方法、参数、返回信息的等等。
@Api:修饰整个类,描述Controller的作用
@ApiOperation:描述一个类的一个方法,或者说一个接口
@ApiParam:单个参数描述
@ApiModel:用对象来接收参数
@ApiModelProperty:用对象接收参数时,描述对象的一个字段
@ApiImplicitParam:一个请求参数
@ApiImplicitParams:多个请求参数