EDP .Net開發框架--WebApi

風輕·雲淡發表於2024-05-20

平臺下載地址:https://gitee.com/alwaysinsist/edp


按分類管理EDP所提供的WebApi介面,以供其他應用呼叫。WebApi介面不僅可以進行訪問控制管理,同時還提供了版本管理,同一WebApi介面支援多個不同版本以滿足介面呼叫方的多版本支援。

WebApi介面的資料是透過呼叫業務方法來獲取的,而業務方法是基於業務物件的,因此WebApi獲取的資料行、列同樣是受許可權管控的。

WebApi開發

public class StudentAPI : WebApiBase
繼承基類WebApiBase

定義介面方法

點選檢視程式碼
/// <summary>
/// 儲存學生資訊
/// </summary>
/// <param name="param"></param>
/// <returns></returns>
public ResultModel<bool> SaveStudent(StudentSaveModel param) {
    StudentModel item = new StudentModel();
    param.CopyTo(item);
    return this.bll_Student.SaveStudent(item.ID, item);
}
StudentSaveModel為定義的輸入參DTO

WebApi管理

WebApi分類

image

WebApi

  • 新增WebApi介面
    image
    image

    選擇程式集後,介面類中會列出所選程式集中包含介面方法的類,選擇類後會列出該介面類下所有的介面方法以供選擇。
    image

  • 編輯WebApi介面
    image

    在編輯WebApi介面的介面會顯示介面的基本資訊,以及列出該介面的所有版本。同時提供介面版本的管理功能,如下圖:新增介面版本。
    image

WebApi除錯與使用

  • WebApi除錯
    image

    介面引數描述
    image

    介面呼叫結果顯示
    image

  • WebApi使用
    在這裡介紹一下第三方的介面呼叫,以Psotman為例。

    登入介面請求
    image
    image

    登入介面請求返回結果
    image

    業務介面請求
    image
    image

    業務介面請求返回結果
    image

相關文章