測試的三大元素
- 穩定性，stabiity
- 功能性core functionality，計費系統的功能（最重要的）類比計算器，嘗試進行test case ，進行matrix
- 性能測試（時間）time
學習資料：
- 總結
- swagger setup
- Swagger從入門到精通
-
各種restful API的比較
image.png
swagger官網資料
edditor
demo
swagerhub
swagger-codegen
swgger_doc_2.0
API和REST
API： 應用程序編程接口，例如：可以用手機的其他軟件分享內容到微信朋友圈或者新浪微博，這些軟件就是與微信和微博的api進行了交互。
REST：是一種架構規則，騰訊公司或其他公司建立API時要遵守的一種規則/風格。
Swagger的用處
Swagger是一個Rest Apis文檔生成工具，通過swagger我們可以使用JSON或者YAML來描述自己的API（可以使用swagger editor來編寫驗證YAML文件）；在編寫好api的yaml文件后，前端可以在swagger ui中查看每個api的輸入與輸出，后端可以通過swagger-codegen工具來生成對應的api框架代碼；通過這種方式來實現前后端分離開發。
如果你是服務端開發人員，也許你要做以下工作：
1、寫接口文檔，描述每個接口的功能，請求參數和返回結果
2、生成API文檔、并進行手動的測試
使用swagger-ui開源工具，建立一個API的集設計，實現，測試，文檔的一體化可視平臺，讓API的開發和使用更加高效
優勢：
Swagger 可以生成一個具有互動性的API控制臺，開發者可以用來快速學習和嘗試API。
Swagger 可以生成客戶端SDK代碼用于各種不同的平臺上的實現。
Swagger 文檔提供了一個方法，使我們可以用指定的 JSON 或者 YAML 摘要來描述API，包括了比如 names、order 等 API 信息。
Swagger的框架
- Swagger Editor – browser-based editor where you can write OpenAPI specs.
- Swagger UI – renders OpenAPI specs as interactive API documentation.
- Swagger Codegen – generates server stubs and client libraries from an OpenAPI spec
操作一：搭建計費系統的環境
實驗項目1：
在docker中存放redis數據庫，計費系統的go項目放在本機MAC上，通過端口在本機MAC上對容器內的PostgreS數據庫進行post、get、delete、put（使用python腳本）。
重點：使用什么端口來通信理解起來有點復雜，花費了我一些時間，先上圖：
1）獲得PostgreS的容器，運行操作如下：
#列出所有運行中容器（含沉睡鏡像)
docker ps -a
#刪除一個運行的容器（如果是第二次運行同一個鏡像要將之前運行的數據刪除）
docker rm +編號前三位就行
#運行redis DB服務器
docker run --name mypostgres -e POSTGRES_PASSWORD=mysecretpassword -p 5432:5432 -d postgres
5432：5432 將容器的數據庫服務通過5432（前一個）暴露給VMvare的5432（后一個端口）
2）下載Navicat for PostgreSQL，在客戶端可以連接數據庫，通過嘗試添加數據，可以證明容器中的數據庫服務已經打開。
3）在MAC中安裝go語言
網上太多，不做陳述，注意GOPATH環境的配置，計費系統的源代碼scr存放的位置要在配置的環境下：/usr/local/go/src/peont（這是我的項目存放位置）。通過go run運行main.go 文件
4）寫python腳本進行手工錄入驗證，看到已經成功錄入
#!/usr/bin/env python
#coding=utf8
import requests,json,time
github_url="http://127.0.0.1:4000/consuming/v1/cost"
data=json.dumps({
'UserId':'1112',
'PriceId':'2222',
'ResourceType':'cpu',
'StartTime':None,
'EndTime':None,
'BillingCost':2.5})
r=requests.post(github_url,data)
print r.text
操作二：寫Swagger API文檔
#OpenAPI 的規范
openapi: 3.0.0
# info section contains API information: title, description (optional), version
info:
title: Sample API
description: Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML.
version: 0.1.9
#API server and base URL，several servers, such as production and sandbox.
servers:
- url: http://api.example.com/v1
description: Optional server description, e.g. Main (production) server
- url: http://staging-api.example.com
description: Optional server description, e.g. Internal staging server for testing
#defines individual endpoints (paths) in your API
#An operation definition includes parameters, request body (if any), possible response status codes (such as 200 OK or 404 Not Found) and response contents.
paths:
/users:
get:
summary: Returns a list of users.
description: Optional extended description in CommonMark or HTML.
#Operations can have parameters passed via URL path (/users/{userId}), query string (/users?role=admin), headers (X-CustomHeader: Value) or cookies (Cookie: debug=0). You can define the parameter data types, format, whether they are required or optional, and other detail
requestBody:
required: true
content:
'application/json':
schema:
type: object
properties:
username:
type: string
responses:
'200': # status code
description: A JSON array of user names
content:
'application/json':
schema:
type: array
items:
type: string
file:///Users/fanfan/Desktop/cloud_intern/swagger/swagger-editor-master/index.html
develop a RESTful API testbed using Swagger
https://scotch.io/tutorials/document-your-already-existing-apis-with-swagger
