WebApi-顾客信息接口示例总结（2017/12/17）

2017-12-17  本文已影响0人  文袁

概述

流程

  1. 新建ASP.NET WebApi应用程序


    image.png

  2. 通过NuGet添加ELinq包、Swashbuckle包

  3. 修改SwaggerConfig.cs配置文件

GlobalConfiguration.Configuration
                .EnableSwagger(c =>
                {
                    c.SingleApiVersion("v1", "WebApiTest");
                    c.IncludeXmlComments(string.Format(@"{0}\bin\WebApiTest.XML",
                        System.AppDomain.CurrentDomain.BaseDirectory));
                })
                .EnableSwaggerUi();

并生成XML文档文件，注意要与配置文件中@"{0}\bin\WebApiTest.XML"的地址要一致


image.png

  1. 在文件夹Controllers中添加Web API控制器类（v2.1）


    image.png
    image.png

  2. 添加实体层，建立映射关系


    image.png

  3. 添加业务处理层
    其中，CustomerService.cs负责业务处理，SsisDbContext.cs负责连接数据库。


    image.png
    image.png

  4. 添加用于指定结果输出格式的类，并使用枚举类型


    image.png
    image.png

  5. 添加用户输入所使用的model


    image.png

  6. 在SwaggerUI的接口文档添加上传文件参数类型，详情可见Abp中SwaggerUI的接口文档添加上传文件参数类型

    image.png

  7. 添加日志记录

  1. 从NuGet下载log4net
  2. 添加log4net.config,采用RollingFileAppender：将日志以回滚文件的形式写到文件中。
  3. 在WebApiConfig中添加注册信息
    log4net.Config.XmlConfigurator.Configure();
  4. AssemblyInfo.cs增加配置：（文件默认相对于当前程序目录-也就是与web.config同目录）
    [assembly:log4net.Config.XmlConfigurator(ConfigFile = "log4net.config", Watch =true)]
  5. 添加LogHelper.cs用于不同级别日志记录和生成。

  1. 加入token认证
    使用md5加密生成token


    image.png

总结

上一篇 下一篇

猜你喜欢

热点阅读