api伺服器搭建api
㈠ 如何使用python 開發一個api
使用 Python 和 Flask 設計 RESTful API
近些年來 REST (REpresentational State Transfer) 已經變成了 web services 和 web APIs 的標配。
在本文中我將向你展示如何簡單地使用 Python 和 Flask 框架來創建一個 RESTful 的 web service。
什麼是 REST？
六條設計規范定義了一個 REST 系統的特點:
客戶端-伺服器: 客戶端和伺服器之間隔離，伺服器提供服務，客戶端進行消費。
無狀態: 從客戶端到伺服器的每個請求都必須包含理解請求所必需的信息。換句話說， 伺服器不會存儲客戶端上一次請求的信息用來給下一次使用。
可緩存: 伺服器必須明示客戶端請求能否緩存。
分層系統: 客戶端和伺服器之間的通信應該以一種標準的方式，就是中間層代替伺服器做出響應的時候，客戶端不需要做任何變動。
統一的介面: 伺服器和客戶端的通信方法必須是統一的。
按需編碼: 伺服器可以提供可執行代碼或腳本，為客戶端在它們的環境中執行。這個約束是唯一一個是可選的。
- ========== ===================== ==================================
- HTTP 方法 行為 示例
- ========== ===================== ==================================
- GET 獲取資源的信息 http://example.com/api/orders
- GET 獲取某個特定資源的信息 http://example.com/api/orders/123
- POST 創建新資源 http://example.com/api/orders
- PUT 更新資源 http://example.com/api/orders/123
- DELETE 刪除資源 http://example.com/api/orders/123
- ========== ====================== ==================================
- ========== =============================================== =============================
- HTTP 方法 URL 動作
- ========== =============================================== ==============================
- GET http://[hostname]/todo/api/v1.0/tasks 檢索任務列表
- GET http://[hostname]/todo/api/v1.0/tasks/[task_id] 檢索某個任務
- POST http://[hostname]/todo/api/v1.0/tasks 創建新任務
- PUT http://[hostname]/todo/api/v1.0/tasks/[task_id] 更新任務
- DELETE http://[hostname]/todo/api/v1.0/tasks/[task_id] 刪除任務
- ========== ================================================ =============================
id: 任務的唯一標識符。數字類型。
title: 簡短的任務描述。字元串類型。
description: 具體的任務描述。文本類型。
done: 任務完成的狀態。布爾值。
- $ mkdir todo-api
- $ cd todo-api
- $ virtualenv flask
- New python executable in flask/bin/python
- Installing setuptools............................done.
- Installing pip...................done.
- $ flask/bin/pip install flask
- #!flask/bin/pythonfrom flask import Flaskapp = Flask(__name__)@app.route('/')def index():
- return "Hello, World!"if __name__ == '__main__':
- app.run(debug=True)
- $ chmod a+x app.py
- $ ./app.py
- * Running on http://127.0.0.1:5000/
- * Restarting with reloader
- #!flask/bin/pythonfrom flask import Flask, jsonifyapp = Flask(__name__)tasks = [
- {
- 'id': 1,
- 'title': u'Buy groceries',
- 'description': u'Milk, Cheese, Pizza, Fruit, Tylenol',
- 'done': False
- },
- {
- 'id': 2,
- 'title': u'Learn Python',
- 'description': u'Need to find a good Python tutorial on the web',
- 'done': False
- }]@app.route('/todo/api/v1.0/tasks', methods=['GET'])def get_tasks():
- return jsonify({'tasks': tasks})if __name__ == '__main__':
- app.run(debug=True)
- $ curl -i http://localhost:5000/todo/api/v1.0/tasks
- HTTP/1.0 200 OK
- Content-Type: application/json
- Content-Length: 294
- Server: Werkzeug/0.8.3 Python/2.7.3
- Date: Mon, 20 May 2013 04:53:53 GMT
- {
- "tasks": [
- {
- "description": "Milk, Cheese, Pizza, Fruit, Tylenol",
- "done": false,
- "id": 1,
- "title": "Buy groceries"
- },
- {
- "description": "Need to find a good Python tutorial on the web",
- "done": false,
- "id": 2,
- "title": "Learn Python"
- }
- ]
- }
- from flask import [email protected]('/todo/api/v1.0/tasks/<int:task_id>', methods=['GET'])def get_task(task_id):
- task = filter(lambda t: t['id'] == task_id, tasks)
- if len(task) == 0:
- abort(404)
- return jsonify({'task': task[0]})
- $ curl -i http://localhost:5000/todo/api/v1.0/tasks/2
- HTTP/1.0 200 OK
- Content-Type: application/json
- Content-Length: 151
- Server: Werkzeug/0.8.3 Python/2.7.3
- Date: Mon, 20 May 2013 05:21:50 GMT
- {
- "task": {
- "description": "Need to find a good Python tutorial on the web",
- "done": false,
- "id": 2,
- "title": "Learn Python"
- }
- }
- $ curl -i http://localhost:5000/todo/api/v1.0/tasks/3
- HTTP/1.0 404 NOT FOUND
- Content-Type: text/html
- Content-Length: 238
- Server: Werkzeug/0.8.3 Python/2.7.3
- Date: Mon, 20 May 2013 05:21:52 GMT
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
- <title>404 Not Found</title>
- <h1>Not Found</h1>
- <p>The requested URL was not found on the server.</p><p>If you entered the URL manually please check your spelling and try again.</p>
- from flask import [email protected](404)def not_found(error):
- return make_response(jsonify({'error': 'Not found'}), 404)
- $ curl -i http://localhost:5000/todo/api/v1.0/tasks/3
- HTTP/1.0 404 NOT FOUND
- Content-Type: application/json
- Content-Length: 26
- Server: Werkzeug/0.8.3 Python/2.7.3
- Date: Mon, 20 May 2013 05:36:54 GMT
- {
- "error": "Not found"
- }
- from flask import [email protected]('/todo/api/v1.0/tasks', methods=['POST'])def create_task():
- if not request.json or not 'title' in request.json:
- abort(400)
- task = {
- 'id': tasks[-1]['id'] + 1,
- 'title': request.json['title'],
- 'description': request.json.get('description', ""),
- 'done': False
- }
- tasks.append(task)
- return jsonify({'task': task}), 201
- $ curl -i -H "Content-Type: application/json" -X POST -d '{"title":"Read a book"}' http://localhost:5000/todo/api/v1.0/tasks
- HTTP/1.0 201 Created
- Content-Type: application/json
- Content-Length: 104
- Server: Werkzeug/0.8.3 Python/2.7.3
- Date: Mon, 20 May 2013 05:56:21 GMT
- {
- "task": {
- "description": "",
- "done": false,
- "id": 3,
- "title": "Read a book"
- }
- }
- curl -i -H "Content-Type: application/json" -X POST -d "{"""title""":"""Read a book"""}" http://localhost:5000/todo/api/v1.0/tasks
- $ curl -i http://localhost:5000/todo/api/v1.0/tasks
- HTTP/1.0 200 OK
- Content-Type: application/json
- Content-Length: 423
- Server: Werkzeug/0.8.3 Python/2.7.3
- Date: Mon, 20 May 2013 05:57:44 GMT
- {
- "tasks": [
- {
- "description": "Milk, Cheese, Pizza, Fruit, Tylenol",
- "done": false,
- "id": 1,
- "title": "Buy groceries"
- },
- {
- "description": "Need to find a good Python tutorial on the web",
- "done": false,
- "id": 2,
- "title": "Learn Python"
- },
- {
- "description": "",
- "done": false,
- "id": 3,
- "title": "Read a book"
- }
- ]
- }
- @app.route('/todo/api/v1.0/tasks/<int:task_id>', methods=['PUT'])def update_task(task_id):
- task = filter(lambda t: t['id'] == task_id, tasks)
- if len(task) == 0:
- abort(404)
- if not request.json:
- abort(400)
- if 'title' in request.json and type(request.json['title']) != unicode:
- abort(400)
- if 'description' in request.json and type(request.json['description']) is not unicode:
- abort(400)
什麼是一個 RESTful 的 web service？
REST 架構的最初目的是適應萬維網的 HTTP 協議。
RESTful web services 概念的核心就是「資源」。 資源可以用URI來表示。客戶端使用 HTTP 協議定義的方法來發送請求到這些 URIs，當然可能會導致這些被訪問的」資源「狀態的改變。
HTTP 標準的方法有如下:
REST 設計不需要特定的數據格式。在請求中數據可以以JSON形式, 或者有時候作為 url 中查詢參數項。
設計一個簡單的 web service
堅持 REST 的准則設計一個 web service 或者 API 的任務就變成一個標識資源被展示出來以及它們是怎樣受不同的請求方法影響的練習。
比如說，我們要編寫一個待辦事項應用程序而且我們想要為它設計一個 web service。要做的第一件事情就是決定用什麼樣的根 URL 來訪問該服務。例如，我們可以通過這個來訪問:
http://[hostname]/todo/api/v1.0/
在這里我已經決定在 URL 中包含應用的名稱以及 API 的版本號。在 URL 中包含應用名稱有助於提供一個命名空間以便區分同一系統上的其它服務。在 URL 中包含版本號能夠幫助以後的更新，如果新版本中存在新的和潛在不兼容的功能，可以不影響依賴於較舊的功能的應用程序。
下一步驟就是選擇將由該服務暴露(展示)的資源。這是一個十分簡單地應用，我們只有任務，因此在我們待辦事項中唯一的資源就是任務。
我們的任務資源將要使用 HTTP 方法如下:
我們定義的任務有如下一些屬性:
目前為止關於我們的 web service 的設計基本完成。剩下的事情就是實現它！
Flask 框架的簡介
如果你讀過Flask Mega-Tutorial 系列，就會知道 Flask 是一個簡單卻十分強大的 Python web 框架。
在我們深入研究 web services 的細節之前，讓我們回顧一下一個普通的 Flask Web 應用程序的結構。
我會首先假設你知道 Python 在你的平台上工作的基本知識。 我將講解的例子是工作在一個類 Unix 操作系統。簡而言之，這意味著它們能工作在 linux，Mac OS X 和 Windows(如果你使用Cygwin)。 如果你使用 Windows 上原生的 Python 版本的話，命令會有所不同。
讓我們開始在一個虛擬環境上安裝 Flask。如果你的系統上沒有 virtualenv，你可以從https://pypi.python.org/pypi/virtualenv上下載:
既然已經安裝了 Flask，現在開始創建一個簡單地網頁應用，我們把它放在一個叫 app.py 的文件中:
為了運行這個程序我們必須執行 app.py:
現在你可以啟動你的網頁瀏覽器，輸入http://localhost:5000看看這個小應用程序的效果。
簡單吧？現在我們將這個應用程序轉換成我們的 RESTful service！
使用 Python 和 Flask 實現 RESTful services
使用 Flask 構建 web services 是十分簡單地，比我在Mega-Tutorial中構建的完整的服務端的應用程序要簡單地多。
在 Flask 中有許多擴展來幫助我們構建 RESTful services，但是在我看來這個任務十分簡單，沒有必要使用 Flask 擴展。
我們 web service 的客戶端需要添加、刪除以及修改任務的服務，因此顯然我們需要一種方式來存儲任務。最直接的方式就是建立一個小型的資料庫，但是資料庫並不是本文的主體。學習在 Flask 中使用合適的資料庫，我強烈建議閱讀Mega-Tutorial。
這里我們直接把任務列表存儲在內存中，因此這些任務列表只會在 web 伺服器運行中工作，在結束的時候就失效。 這種方式只是適用我們自己開發的 web 伺服器，不適用於生產環境的 web 伺服器， 這種情況一個合適的資料庫的搭建是必須的。
我們現在來實現 web service 的第一個入口:
正如你所見，沒有多大的變化。我們創建一個任務的內存資料庫，這里無非就是一個字典和數組。數組中的每一個元素都具有上述定義的任務的屬性。
取代了首頁，我們現在擁有一個 get_tasks 的函數，訪問的 URI 為 /todo/api/v1.0/tasks，並且只允許 GET 的 HTTP 方法。
這個函數的響應不是文本，我們使用 JSON 數據格式來響應，Flask 的 jsonify 函數從我們的數據結構中生成。
使用網頁瀏覽器來測試我們的 web service 不是一個最好的注意，因為網頁瀏覽器上不能輕易地模擬所有的 HTTP 請求的方法。相反，我們會使用 curl。如果你還沒有安裝 curl 的話，請立即安裝它。
通過執行 app.py，啟動 web service。接著打開一個新的控制台窗口，運行以下命令:
我們已經成功地調用我們的 RESTful service 的一個函數！
現在我們開始編寫 GET 方法請求我們的任務資源的第二個版本。這是一個用來返回單獨一個任務的函數:
第二個函數有些意思。這里我們得到了 URL 中任務的 id，接著 Flask 把它轉換成 函數中的 task_id 的參數。
我們用這個參數來搜索我們的任務數組。如果我們的資料庫中不存在搜索的 id，我們將會返回一個類似 404 的錯誤，根據 HTTP 規范的意思是 「資源未找到」。
如果我們找到相應的任務，那麼我們只需將它用 jsonify 打包成 JSON 格式並將其發送作為響應，就像我們以前那樣處理整個任務集合。
調用 curl 請求的結果如下:
當我們請求 id #2 的資源時候，我們獲取到了，但是當我們請求 #3 的時候返回了 404 錯誤。有關錯誤奇怪的是返回的是 HTML 信息而不是 JSON，這是因為 Flask 按照默認方式生成 404 響應。由於這是一個 Web service 客戶端希望我們總是以 JSON 格式回應，所以我們需要改善我們的 404 錯誤處理程序:
我們會得到一個友好的錯誤提示:
接下來就是 POST 方法，我們用來在我們的任務資料庫中插入一個新的任務:
添加一個新的任務也是相當容易地。只有當請求以 JSON 格式形式，request.json 才會有請求的數據。如果沒有數據，或者存在數據但是缺少 title 項，我們將會返回 400，這是表示請求無效。
接著我們會創建一個新的任務字典，使用最後一個任務的 id + 1 作為該任務的 id。我們允許 description 欄位缺失，並且假設 done 欄位設置成 False。
我們把新的任務添加到我們的任務數組中，並且把新添加的任務和狀態 201 響應給客戶端。
使用如下的 curl 命令來測試這個新的函數:
注意：如果你在 Windows 上並且運行 Cygwin 版本的 curl，上面的命令不會有任何問題。然而，如果你使用原生的 curl，命令會有些不同:
當然在完成這個請求後，我們可以得到任務的更新列表:
剩下的兩個函數如下所示:
㈡ 易語言怎樣用api實現伺服器、客戶組建的功能
可以搜索下Socket套接字，一般的流程是：
WSAStartup 初始化Socket庫
socket 創建Socket實例 ，也就是這步確定是UDP還是TCP,是客戶還是伺服器
然後伺服器則是bind綁定埠，listen監聽埠,recv接收數據,sned發送數據
客戶則是connect連接客戶端，接收和發送和伺服器一樣
數據報則是bind綁定，recvfrom接收數據，sendto發送數據
當然最後還需要closeSocket關閉套接字實例和WSACleanup釋放套接字型檔
我這里這是簡單的提一下流程，具體的要參看專門講Socket的教程！
㈢ YAPI:從0搭建API文檔管理工具
最近在找一款API文檔管理工具，之前有用過Swagger、API Manager、Confluence，現在用的還是Confluence。
我個人一直不喜歡用Swagger，感覺「代碼即文檔」，讓代碼里的文檔無處不在，已經對代碼造成了一定的入侵了。API Manager就是一個純API文檔管理的工具了。Confluence是萬能的，也是最簡單的，支持各種插件在線安裝，可以有各種布局，支持MD文檔，也支持表格、代碼塊等。
最近看到一篇文章在說YAPI，就准備搭建一個試試效果如何。
YAPI是去哪兒網開源的一款API管理工具，理念如下：
特性：
選擇YAPI試試手的原因是因為我看到了它支持MockServer，這樣前端開發同學就不用等待後端同學了。主要是我也懶得搭建一套mock服務，有這樣一款工具何樂而不為呢？所以今天就找了一台伺服器安裝了一下。考慮排版問題，就以圖片形式放出來了。
nodeJS長期支持版本官網下載地址：https://nodejs.org/dist/v10.16.0/node-v10.16.0-linux-x64.tar.xz，下載後執行如下命令：
nodeJS安裝完畢。
YAPI安裝，GitHub上已經有比較詳細的文檔了，地址：https://github.com/YMFE/yapi，這里說一下兩種部署方式：
可視化部署：
yapi安裝完畢，訪問http://127.0.0.1:9090進行可視化配置一步一步往下走即可。
命令行部署（推薦方式）：
yapi安裝完畢，訪問http://127.0.0.1:{config.json中配置的port}即可訪問。
node需要安裝pm2模塊，使用pm2模塊後台運行yapi：
運行成功頁面：
至此，YAPI就安裝完畢了，簡單實用一下還是不錯的，因為是國產的，整體操作風格還是比較習慣的。在YAPI這里介面更改還有記錄哦~
後面再慢慢體驗這個裡面的一些高級功能吧，比如MockServer、介面測試等功能。
大家還有什麼更好用的API管理工具？你覺得一款優秀的API管理工具應該都有哪些必須的功能？歡迎推薦和討論！
㈣ api伺服器簡介
了解規則
人們創造了社交禮儀來指引他們的交流。一個例子就是我們如何用電話和其他人交流。假設你正和朋友通話。當他們說話的時候，你知道自己應該保持安靜。你知道應該允許他們有短暫的停頓。如果他們問了一個問題，然後保持沉默，你知道他們希望得到回應，現在該你說話了。
計算機有相似的禮儀，雖然它們使用的術語是「協議」。計算機協議就是一組已經被接受的規則，這些規則約束計算機如何交談。然而，和我們的標准相比，計算機協議是非常死板的。花點時間想想這兩個句子「我最喜歡的顏色是藍色」和「藍色是我最喜歡的顏色」。雖然它們使用的詞的順序是不同的，但是我們可以分解這兩個句子並且知道它們的意思是一樣的。很不幸，計算機沒那麼聰明。
為了讓兩台計算機有效的交流，伺服器必須准確的知道客戶端會如何排列它的信息。你可以類比一個人詢問一個郵件地址。當你詢問一個地址的位置時，你假設首先被告知的是街道地址，隨後是城市，州，最後是郵政編碼。對於地址的每一部分，你也許會有特定的期望，比如郵政編碼應該只包含數字。計算機協議要想工作也需要類似的細節。
Web協議
有一個協議是幾乎針對一切的：每一個協議完成不同的工作。你可能聽說過一些協議：通信設備上用的藍牙，收郵件的POP或者IMAP。
在Web上，最主要的協議是超文本傳輸協議，它的縮寫更知名一些，HTTP。當你在瀏覽器中輸入http://example.com 這樣的地址的時候，「http」告訴瀏覽器使用HTTP的規則和伺服器通信。
由於HTTP在web上無處不在，因此很多公司選擇它作為自己的API的底層協議。使用熟悉的協議的一個好處就是可以降低開發者的學習曲線，鼓勵他們使用API。另一個好處是HTTP有幾個特性對於構建一個好的API非常有用，隨後我們會看到。現在讓我們擦去迷霧，看一看HTTP是如何工作的吧。
㈤ 怎麼用API網關構建微服務
由於這些問題的存在,客戶端與微服務直接通信很少是合理的。 使用API網關通常,一個更好的方法是使用所謂的API網關。API網關是一個伺服器,是系統的唯一...
㈥ API伺服器是什麼意思
簡單來說，你使用的api介面會把參數消息傳到給api伺服器，然後api伺服器返回一個處理好消息給你。想像成函數過程的話，就是你使用了這個函數（就是傳參），知道返回類型，能得到返回值，具體函數體（也就是api伺服器）是怎麼做到的你不需要知道。