RESTful APIを簡単に作成するノードを使用します.JSはパート1
3433 ワード
何がRESTful APIですか?
最初に、API、アプリケーションプログラミングインターフェースのための短い、単に2つ以上のサービスの間のコミュニケーションの方法である、時々、ユーザー/クライアントと彼らが要求する資源/サービスの間の調停者として記述されます.しかしながら、RESTful APIはRESTアーキテクチャスタイルの制約に準拠し、RESTful Webサービスとの統合を可能にする一連の原則です.
ステップ。1 :新規プロジェクトの初期化
非常に最初の手順は、手動で空のフォルダを手動で選択したディレクトリ(右クリックを使用)、またはターミナル/bash経由で作成することです.
mkdir myProject
cd ./myProject
次に、新しい空のNPMパッケージをレガシーinit (npm init -y
最初にノードを持たなければならないことに注意してください.あなたのマシンにインストールされているJS.別の側面には、パッケージを編集することができます.JSONファイルと指定された情報を追加します.ステップ。2 :必要な依存関係のインストール
私は最も基本的なセットアップを非常に単純なRESTful APIを作成するために使用するでしょうが、あなたは間違いなく便利な他のパッケージを追加することができます.私が使用する2つの主なパッケージは、最小のノードであるExpressです.JSフレームワークは、私たちのワークロードを簡素化するために使用され、クロスのリソースリソースの共有を処理するCors.
npm i express cors
また、ディレクトリ内のファイルの変更が検出されたときに自動的にノードアプリケーションを再起動するツールです.npm i --save-dev nodemon
ステップ。エントリポイントの作成
次のステップは、ノードのエントリポイントを作成することです.プロジェクトのルート内のJSアプリケーション(通常はindex . jsという名前).パッケージを変更します.JSONファイルは次のようになります.
{
"name": "project-name",
"version": "1.0.0",
"description": "Add project description here if you want to",
"main": "index.js",
"type": "module",
"scripts": {
"start": "node index.js",
"start-dev": "nodemon index.js",
},
"keywords": [],
"author": "your-name",
"license": "ISC"
}
私たちのアプリケーションをローカル(開発環境)で実行するためには、2番目のスクリプト(start dev)を使います.もう一つの側面は、パッケージに「タイプ」:「モジュール」を加えることです.JSONはES 6機能を有効にします.次に、我々のアプリを起動する前に、新しく作成されたインデックスを開きます.JSファイルを追加し、次のように追加します.
import express from "express"
import cors from "cors"
const app = express()
app.use(express.urlencoded({ extended: false }))
app.use(express.json())
app.use(cors())
const port = process.env.PORT || 5000
app.get("/", (req, res) => {
res.send("Welcome to our new custom API!")
})
app.use((req, res, next) => {
const error = new Error("Something went wrong")
error.status = 404
next(error)
})
app.use((error, req, res, next) => {
res.status(error.status || 500)
res.json({
error: {
message: error.message,
},
})
})
app.listen(port, (err) => {
if (err) throw new Error("Error while connecting to the server")
console.log(`Server is live and running at: http://localhost:${port}`)
})
export default app
上記の設定を通じて、我々はExpressを使用して我々のアプリを開始、いくつかの便利な表現方法と呼ばれる、と我々は以前にインストールしたCorsパッケージを使用します.また、ポート変数を割り当て、私たちのAPIを呼び出すときに歓迎メッセージを作成し、単に予期しない将来のエラーを処理します.最後に、しかし、少なくとも、我々は我々のカスタムポートでサーバーを始めるために、聞いている方法を呼びました.次のコマンドを端末で起動します.
npm run start-dev
端末で提供されているCtrl + linkを押すと、以下のようにlocalhostサーバが起動します.最後の思考
この例を通して、私たちは非常に基本的なRESTful APIを作成しました.もちろん、APIのための良いビルディングブロックです.今後の部分では、我々のAPIに機能を追加し、データベースに接続せずにテストします.ステイ!
Reference
この問題について(RESTful APIを簡単に作成するノードを使用します.JSはパート1), 我々は、より多くの情報をここで見つけました https://dev.to/iamshour/creating-a-restful-api-easily-using-nodejs-part-1-2fh2テキストは自由に共有またはコピーできます。ただし、このドキュメントのURLは参考URLとして残しておいてください。
Collection and Share based on the CC Protocol