HTTP通信をラクに実装できる「axios」の基本

最近、HTTP通信にaxiosを使う機会があったので、基本的な使い方からエラー処理などまで、備忘録として基本的な部分をまとめておきます。
axios
まずaxiosは「アクシオス」と読み、もともとギリシャ語で「値する」という意味らしいです。
PromiseベースのHTTPクライアントで、非同期なHTTP通信が簡単に実装できます。
また、Vue.jsでは非同期通信にaxiosを使うことがスタンダードになっています。
インストール方法
npmを使ってインストールする場合は下記。
$ npm install axios --saveyarnの場合は下記コマンド。
$ yarn add axiosCDNを利用する場合のタグを追加します。
<script src="https://unpkg.com/axios/dist/axios.min.js"><script>基本の使い方
GET通信
GET通信をしたいときはaxios.get()を使用します。
第1引数にURLを指定し、通信の結果によってそこから分岐します。
- .then():通信が成功したときの処理
- .catch():エラー時の処理
- .finally():通信が成功しても失敗しても行う処理
axios.get('URL')
.then(function (response) {
// 通信が成功したときの処理
console.log(response);
})
.catch(function (error) {
// エラー時の処理
console.log(error);
})
.finally(function () {
// 常に実行する処理
});レスポンスは下記になります。
response.dataにデータが入っているので、そこさえ覚えておけばOKです。
| レスポンス | 中身 |
|---|---|
| response.data | レスポンスデータ |
| response.status | ステータスコード |
| response.statusText | ステータステキスト |
| response.header | レスポンスヘッダ |
| response.config | コンフィグ |
POST通信
POST通信をしたいときはaxios.post()を使用します。
第1引数にURLを指定し、第2引数に送信したいデータを指定します。
axios.post('/user', {
id: 1,
name: 'user_name'
})
.then(function (response) {
// 通信が成功したときの処理
console.log(response.data);
})
.catch(function (error) {
// エラー時の処理
console.log(error);
})
.finally(function () {
// 常に実行する処理
});axios APIの使用
axios()で様々なオプションを指定することで、カスタムヘッダーの送信やTokenの送信、ベーシック認証のかかったページへの通信も可能です。
GET通信の基本の形が下記になります。
axios({
method: 'get',
url: 'GETするURL',
})POST通信の場合は下記になります。
axios({
method: 'post',
url: 'POSTするURL',
data: {
id: 1,
name: 'user_name'
}
});カスタムヘッダーの送信
カスタムヘッダーの追加は「headers」で行えます。
axios({
method: 'post',
url: 'POSTするURL',
headers: {
// ここにカスタムヘッダーの内容を追加
},
})ベーシック認証のかかったページへの通信
ベーシック認証のかかったページへの通信を行いたい場合は「auth」内の「username」と「password」にユーザー名とパスワードを入力するだけです。
axios({
method: 'get',
url: 'GETするURL',
auth: {
username : 'user',
password : 'pass'
},
})fetchなどでベーシック認証をしようとすると、btoaを使ってユーザー名とパスワードを「:」で区切った文字列を変換しないといけなかったりします。
それと比べると分かりやすくてラクですね。

SafariでFacebookのPage Pluginに「リクエストを処理できませんでした」とダイアログが表示される問題
Vue CLIでVue.jsの開発環境をセットアップするまでの流れ
JavaScriptのforEach内で「continue」や「break」のような動作をさせる方法
gulpでSSI(サーバーサイドインクルード)を使用する「connect-ssi」
CSSで1行で簡単にスムーススクロールを実装できる「scroll-behavior」プロパティ
Visual Studio Codeで複数ファイルを編集するときにタブやペインの操作方法
Visual Studio Codeで連番を入力する拡張機能「vscode-input-sequence」
コーディングで「スペース」と「タブ」のどちらを使えばいいのか?
常時SSL化の設定をしたのに「保護された通信」が表示されない時はパスにHTTPが残っているのかも?
「DevTools z-index」でz-indexがかかっている要素をChrome開発者ツールに一覧表示させる
AirPodsで片耳を外しても再生が止まらないようにする方法
MacのKeynoteにハイライトされた状態でコードを貼り付ける方法
iTerm2でマウスやトラックパッドの操作を設定できる環境設定の「Pointer」タブ
DeepLで「インターネット接続に問題があります」と表示されて翻訳できないときに確認すること
Ulyssesの「第2のエディタ」表示を使って2つのシートを横並びに表示する
iPhoneで特定のアプリだけ別の言語設定に切り替える方法
MacのQuick Lookをもっと便利にしてくれるプラグインまとめ
Figmaで作ったスマホデザインを「Mirror」機能を使ってリアルタイムに実機確認をする
Marpで既存Markdownファイルを使ったスライド作成時に、見出しごとにスライドを分割する方法
自分の管理下にないどうしようもできないログイン情報は1Passwordの「脆弱なパスワード」を無視しておく
WordPressで「現在メンテナンス中のため、しばらくの間ご利用いただけません。」の状態でログインできなくなった場合の対処法
Google Maps APIでピンのアクティブ時にピン画像を変える方法
CPUの温度が熱すぎるのを防ぐMacのファンコントロールアプリ
Alfredで現在開いているフォルダ内の画像をImageOptimで圧縮するWorkflowの作り方
1PasswordとAlfredを連携してログイン情報の検索を行う方法