Web Api 2 介面API文件美化

使用用第三方提供的swgger ui 幫助提高 web api 介面列表的閱讀性，並且可以在頁面中測試服務介面。

執行程式如下：

注意：在ie中必須輸入紅色部分。

並且可以對方法進行測試。

在開發web api 是可以寫清楚注釋，並且在文件中可以全部的顯示出來。

在工程中處了安裝swashbuckle 以外，還會用到owin,system.web.http.owin庫

夾中生成乙個檔名為「swaggerconfig」的檔案。並修改如下：

24:

27:      }

28:  }

在工程中新增乙個startup的檔案，**如下：

1:

2:  

12:

22:      }

23:  }

新建乙個studentcontroller:

1:  

namespace webapi.controllers

2:

16:

17:  

/// 

18:  

/// 根據學生編號得到學生資訊

19:  

/// 

20:  

/// 學生編號

21:  

/// 

22:  

public studentmodel get(int id)

23:          ;

25:          }

26:

27:  

/// 

28:  

/// 新增學生

29:  

/// 

30:  

/// 學生實體

31:  

/// 新增乙個新的學生

32:  

/// bad request 

33:  

/// internal server error

34:  

public
void post(studentmodel studentmodel)

35:

37:

38:

39:  

/// 

40:  

/// 修改學生資訊

41:  

/// 

42:  

/// 學生編號

43:  

/// 學生實體

44:

45:          [responsetype(typeof(studentmodel))]

46:          [actionname("updatestudentbyid")]

47:  

public
void put(int id, [form]string studentmodel)

48:

51:

52:  

/// 

53:  

/// 刪除學生資訊

54:  

/// 

55:  

/// 學生編號

56:  

public
void delete(int id)

57:

59:

60:  

/// 

61:  

/// 根據學生姓名得到學生資訊

62:  

/// 

63:  

/// 學生姓名

71:

74:      }

75:  }

這裡的「bin\webapi.xml」檔名稱和swaggerconfig檔案中的配置保持一樣。

Docker搭建Rap2介面文件

git clone 二 切換到當前目錄下通過docker compose的方式啟動 docker compose up d 三 初始化容器環境 進入容器 docker exec it rap2 delos sh 初始化node node scripts init 退出容器 exit t停止容器 do...

TypeScript 基礎2 介面

介面通常以inte ce來宣告，介面是抽象方法的集合，即只宣告，不定義具體值。類描述物件的屬性和方法。介面則包含類要實現的方法 除非實現介面的類是抽象類，否則該類要定義介面中的所有方法 乙個實現介面的類，必須實現介面內所描述的所有方法，否則就必須宣告為抽象類。介面支援多繼承，乙個類可以實現多個介面 ...

Web API系列 二 介面安全和引數校驗

以前簡單介紹過web api 的設計，但是還是有很多朋友問我，如何合理的設計和實現web api。比如，介面安全，異常處理，統一資料返回等問題。所以有必要系統的總結總結 web api 的設計和實現。由於前面已經介紹過web api 的引數和返回格式的設計，web api系列 一 設計經驗與總結 這...