サーバ - HTTP API - 版の履歴

2026年1月3日 (土) 03:21にWikiによる

2026-01-03T03:21:04Z

Wiki: /* CI/CD環境の構築 */

2026-01-03T03:02:43Z

CI/CD環境の構築

← 古い版		2026年1月3日 (土) 12:02時点における版
1,164行目:		1,164行目:
	test:		test:
	runs-on: ubuntu-latest		runs-on: ubuntu-latest

	steps:		steps:
	- uses: actions/checkout@v2		- uses: actions/checkout@v2

	- name: Set up Python		- name: Set up Python
	uses: actions/setup-python@v2		uses: actions/setup-python@v2
	with:		with:
	python-version: '3.9'		python-version: '3.9'

	- name: Install dependencies		- name: Install dependencies
	run: \|		run: \|
1,178行目:		1,178行目:
	pip install -r requirements.txt		pip install -r requirements.txt
	pip install pytest pytest-cov		pip install pytest pytest-cov

	- name: Run tests		- name: Run tests
	run: \|		run: \|
	pytest --cov=app tests/		pytest --cov=app tests/

	deploy:		deploy:
	needs: test		needs: test
	runs-on: ubuntu-latest		runs-on: ubuntu-latest
	if: github.ref == 'refs/heads/main'		if: github.ref == 'refs/heads/main'

	steps:		steps:
	- name: Deploy to server		- name: Deploy to server

Wiki: /* 監視とログ管理 */

2026-01-03T03:01:51Z

監視とログ管理

← 古い版		2026年1月3日 (土) 12:01時点における版
1,041行目:		1,041行目:
	<br>		<br>
	Webブラウザで http://localhost:3000 にアクセスして、Grafanaにログインする。<br>		Webブラウザで http://localhost:3000 にアクセスして、Grafanaにログインする。<br>
	~~デフォルトのログイン情報は、ユーザ名~~: ~~admin、パスワード~~: admin ~~である。<br>~~		デフォルトのログイン情報を以下に示す。<br>
			* ユーザ名
			*: admin
			* パスワード
			*: admin
	<br>		<br>
	==== ログ管理 ====		==== ログ管理 ====
1,062行目:		1,066行目:
	</syntaxhighlight>		</syntaxhighlight>
	<br>		<br>
	~~構造化ログの実装例を示す。~~<br>		構造化ログの例を以下に示す。<br>
	<syntaxhighlight lang="python">		<syntaxhighlight lang="python">
	# logging_config.pyファイル		# logging_config.pyファイル
1,080行目:		1,084行目:
	'line': record.lineno		'line': record.lineno
	}		}

	if hasattr(record, 'user_id'):		if hasattr(record, 'user_id'):
	log_data['user_id'] = record.user_id		log_data['user_id'] = record.user_id

	if record.exc_info:		if record.exc_info:
	log_data['exception'] = self.formatException(record.exc_info)		log_data['exception'] = self.formatException(record.exc_info)

	return json.dumps(log_data)		return json.dumps(log_data)

1,093行目:		1,097行目:
	logger = logging.getLogger(name)		logger = logging.getLogger(name)
	logger.setLevel(logging.INFO)		logger.setLevel(logging.INFO)

	handler = logging.FileHandler('/var/log/myapi/app.log')		handler = logging.FileHandler('/var/log/myapi/app.log')
	handler.setFormatter(JSONFormatter())		handler.setFormatter(JSONFormatter())

	logger.addHandler(handler)		logger.addHandler(handler)
	return logger		return logger

Wiki: /* HTTPS対応 */

2026-01-03T02:59:05Z

HTTPS対応

← 古い版		2026年1月3日 (土) 11:59時点における版
747行目:		747行目:

	== HTTPS対応 ==		== HTTPS対応 ==
	==== Let's ~~Encryptを使用する場合~~ ====		==== Let's Encryptの使用 ====
	Certbotをインストールする。<br>		Certbotをインストールする。<br>
	# RHEL		# RHEL
768行目:		768行目:
	0 3 * * * certbot renew --quiet		0 3 * * * certbot renew --quiet
	<br>		<br>
	==== ~~自己署名証明書を使用する場合~~ ====		==== 自己署名証明書の使用 ====
	開発環境やテスト環境では、自己署名証明書を使用することができる。<br>		開発環境やテスト環境では、自己署名証明書を使用することができる。<br>
	<br>		<br>
	openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365 -nodes		openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365 -nodes
	<br>		<br>
	~~Pythonアプリケーションで使用する場合の例を示す。~~<br>		以下の例では、Pythonアプリケーションで使用している。<br>
	<syntaxhighlight lang="python">		<syntaxhighlight lang="python">
	# HTTPS対応でFlaskアプリを起動		# HTTPS対応でFlaskアプリを起動

Wiki: /* レート制限の実装 */

2026-01-03T02:58:15Z

レート制限の実装

← 古い版		2026年1月3日 (土) 11:58時点における版
714行目:		714行目:
	<br><br>		<br><br>

	== ~~レート制限の実装~~ ==		== レート制限 ==
	~~レート制限を実装することにより、API呼び出しの過度な使用を防止して、サーバリソースを保護することができる。~~<br>		レート制限を行うことにより、API呼び出しの過度な使用を防止して、サーバリソースを保護することができる。<br>
	<br>		<br>
	~~必要なライブラリをインストールする。~~<br>		レート制限に必要なライブラリをインストールする。<br>
	pip install flask-limiter		pip install flask-limiter
	<br>		<br>

Wiki: /* 認証と認可の実装 */

2026-01-03T02:57:44Z

認証と認可の実装

← 古い版		2026年1月3日 (土) 11:57時点における版
633行目:		633行目:
	<br><br>		<br><br>

	== ~~認証と認可の実装~~ ==		== 認証と認可 ==
	==== ~~APIキー認証を実装する場合~~ ====		==== APIキー認証 ====
	~~Python~~ + ~~Flaskでの実装例を示す。~~<br>		以下の例では、Python + FlaskでAPI認証を行っている。<br>
	<syntaxhighlight lang="python">		<syntaxhighlight lang="python">
	# auth.pyファイル		# auth.pyファイル
650行目:		650行目:
	def decorated_function(args, *kwargs):		def decorated_function(args, *kwargs):
	api_key = request.headers.get('X-API-Key')		api_key = request.headers.get('X-API-Key')

	if not api_key or api_key not in VALID_API_KEYS:		if not api_key or api_key not in VALID_API_KEYS:
	return jsonify({'error': 'Invalid or missing API key'}), 401		return jsonify({'error': 'Invalid or missing API key'}), 401

	return f(args, *kwargs)		return f(args, *kwargs)
	return decorated_function		return decorated_function
664行目:		664行目:
	</syntaxhighlight>		</syntaxhighlight>
	<br>		<br>
	==== ~~JWT認証を実装する場合~~ ====		==== JWT認証 ====
	~~必要なライブラリをインストールする。~~<br>		JWT認証に必要なライブラリをインストールする。<br>
	pip install pyjwt		pip install pyjwt
	<br>		<br>
	~~JWT認証の実装例を示す。~~<br>		以下の例では、JWT認証を行っている。<br>
	<syntaxhighlight lang="python">		<syntaxhighlight lang="python">
	# jwt_auth.pyファイル		# jwt_auth.pyファイル

Wiki: /* MariaDBのインストール */

2026-01-03T02:54:27Z

MariaDBのインストール

← 古い版		2026年1月3日 (土) 11:54時点における版
266行目:		266行目:
	==== MariaDBを使用する場合 ====		==== MariaDBを使用する場合 ====
	===== MariaDBのインストール =====		===== MariaDBのインストール =====
	~~MariaDBをインストールする。~~<br>		まず、[[インストール_-_MariaDB\|インストール - MariaDBのページ]]を参照して、MariaDBをインストールする。<br>
	~~# RHEL~~
	~~sudo dnf install mariadb-server mariadb~~

	~~# SUSE~~
	~~sudo zypper install mariadb mariadb-client~~

	~~# Raspberry Pi~~
	~~sudo apt install mariadb-server mariadb-client~~
	<br>		<br>
	MariaDBサービスを起動して、自動起動を有効にする。<br>		MariaDBサービスを起動して、自動起動を有効にする。<br>
280行目:		272行目:
	sudo systemctl enable mariadb		sudo systemctl enable mariadb
	<br>		<br>
	~~MariaDBのセキュリティを設定する。~~<br>		次に、[[インストール - MariaDB#MariaDBの設定のページ]]を参照して、MariaDBのセキュリティを設定する。<br>
	* rootパスワードの設定		* rootパスワードの設定
	* anonymousユーザの削除		* anonymousユーザの削除
289行目:		281行目:
	sudo mysql_secure_installation		sudo mysql_secure_installation
	<br>		<br>
	~~MariaDBへログインして、データベースの作成、ユーザの作成、権限の設定を行う。~~<br>		次に、MariaDBへログインして、データベースの作成、ユーザの作成、権限の設定を行う。<br>
	sudo mysql -u root -p		sudo mysql -u root -p

335行目:		327行目:
	</syntaxhighlight>		</syntaxhighlight>
	<br>		<br>

	===== バックアップ設定 =====		===== バックアップ設定 =====
	バックアップスクリプトを作成する。<br>		バックアップスクリプトを作成する。<br>

Wiki: /* Node.js + Expressを使用する場合 */

2026-01-03T02:31:57Z

Node.js + Expressを使用する場合

← 古い版		2026年1月3日 (土) 11:31時点における版
200行目:		200行目:
	==== Node.js + Expressを使用する場合 ====		==== Node.js + Expressを使用する場合 ====
	Node.jsをインストールする。<br>		Node.jsをインストールする。<br>
	Node.jsの詳細なインストール手順は、[[インストール_-_Node.js\|~~インストール_~~-~~_Node~~.js]]を参照すること。<br>		Node.jsの詳細なインストール手順は、[[インストール_-_Node.js\|インストール - Node.js]]を参照すること。<br>
	<br>		<br>
	プロジェクトディレクトリを作成する。<br>		プロジェクトディレクトリを作成する。<br>
210行目:		210行目:
	npm install express body-parser cors helmet		npm install express body-parser cors helmet
	<br>		<br>

	==== Go言語を使用する場合 ====		==== Go言語を使用する場合 ====
	Go言語をインストールする。<br>		Go言語をインストールする。<br>

Wiki: /* 開発言語とフレームワークの選択 */

2026-01-03T02:31:04Z

開発言語とフレームワークの選択

← 古い版		2026年1月3日 (土) 11:31時点における版
111行目:		111行目:
	<br>		<br>
	<u>※注意</u><br>		<u>※注意</u><br>
	<u>venv/bin/~~activateスクリプトを、~~~/.~~profileファイル等に設定することは非推奨である。~~</u><br>		<u>venv/bin/activateスクリプトの設定を~/.profileファイル等に記述することは非推奨である。</u><br>
			<br>
	<u>activateスクリプトは相対パスで動作するため、フルパスで指定する必要がある。</u><br>		<u>activateスクリプトは相対パスで動作するため、フルパスで指定する必要がある。</u><br>
	<u>~~これは、常に特定の仮想環境がアクティブになってしまうため、他のプロジェクトで異なる仮想環境を使用する場合に問題が発生するからである。~~</u><br>		<u>これは、常に特定の仮想環境がアクティブになってしまうため、他のプロジェクトで異なる仮想環境を使用する場合に問題が発生するためである。</u><br>
	<br>		<br>
	<u>~~また、シェルのセッションごとに自動的にアクティベートすると、どの環境で作業しているのか理解しにくい。~~</u~~><br~~>		<u>また、シェルのセッションごとに自動的にアクティベートすると、どの環境で作業しているのか理解し難い。</u>
	<br>		<br>
	代替案として、以下に示すような方法が推奨される。<br>		代替案として、以下に示すような方法が推奨される。<br>
	以下に示すような方法ならば、必要な時のみ仮想環境をアクティベートすることが可能なため、柔軟な運用が可能になる。<br>		以下に示すような方法ならば、必要な時のみ仮想環境をアクティベートすることが可能なため、柔軟な運用が可能になる。<br>
	<br>		<br>
	~~特に、複数のプロジェクトを扱う場合は、2番目や3番目の方法が便利である。~~<br>		特に、複数のプロジェクトを扱う場合は、"方法 2" や "方法 3" が便利である。<br>
	<br>		<br>
			* エイリアスを設定する方法
			*: ~/.profileファイル等に記述する。
	<syntaxhighlight lang="sh">		<syntaxhighlight lang="sh">
	# 方法 1		# 方法 1
	~~# エイリアスを設定する方法 (~/.profileファイル等に記述)~~

	alias activate-~~myproject~~='source <activateスクリプトのパス>'		alias activate-mcpserver="source <activateスクリプトのパス>"
	</syntaxhighlight>		</syntaxhighlight>
	<br>		<br>
			* プロジェクトディレクトリに入った時のみ自動的にアクティベートする方法
			*: ~/.profileファイルまたは ~/.zprofileファイル等に記述する。
	<syntaxhighlight lang="sh">		<syntaxhighlight lang="sh">
	# 方法 2		# 方法 2 (a) : Bash / Zsh
	~~# プロジェクトディレクトリに入った時のみ自動的にアクティベートする方法~~ (~/~~.profileファイル等に記述)~~

	function cd()		function check_venv()
	{		{
	~~builtin cd "$@"~~

	~~# プロジェクトディレクトリに入った時のみ仮想環境をアクティベート~~
	if [ -d "venv" ]; then		if [ -d "venv" ]; then
	~~# 既に仮想環境がアクティブでない場合のみ~~
	if [ -z "$VIRTUAL_ENV" ]; then		if [ -z "$VIRTUAL_ENV" ]; then
			source venv/bin/activate
			elif [ "$VIRTUAL_ENV" != "$PWD/venv" ]; then
			deactivate
	source venv/bin/activate		source venv/bin/activate
	fi		fi
			elif [ -n "$VIRTUAL_ENV" ]; then
			deactivate
	fi		fi
	}		}

			function cd()
			{
			builtin cd "$@"
			check_venv
			}

			# プロンプト表示前に毎回チェック
			PROMPT_COMMAND="check_venv${PROMPT_COMMAND:+;$PROMPT_COMMAND}"

			# シェル起動時にもチェック
			check_venv
	</syntaxhighlight>		</syntaxhighlight>
	<br>		<br>
			* プロジェクトディレクトリに入った時のみ自動的にアクティベートする方法
			*: ~/.config/fish/config.fishファイルおよび ~/.config/fish/functions/check_venv.fishファイルに記述する。
			<syntaxhighlight lang="fish">
			# 方法 2 (b) : Fish

			# ~/.config/fish/config.fishファイル
			check_venv

			# ~/.config/fish/functions/check_venv.fishファイル
			function check_venv --on-variable PWD --on-event fish_prompt
			if test -d "venv"
			if test -z "$VIRTUAL_ENV"
			source venv/bin/activate.fish
			else if test "$VIRTUAL_ENV" != "$PWD/venv"
			deactivate
			source venv/bin/activate.fish
			end
			else if test -n "$VIRTUAL_ENV"
			deactivate
			end
			end

			function cd
			builtin cd $argv
			end
			</syntaxhighlight>
			<br>
			* direnvのような専用ツールを使用する方法
			*: プロジェクトディレクトリの.envrcファイルに記述する。
	<syntaxhighlight lang="sh">		<syntaxhighlight lang="sh">
	# 方法 3		# 方法 3
	~~# direnvのような専用ツールを使用する方法~~
	~~# プロジェクトディレクトリの.envrcファイルに記述~~

	layout python3 # Pythonの仮想環境を自動的に管理		layout python3 # Pythonの仮想環境を自動的に管理
157行目:		200行目:
	==== Node.js + Expressを使用する場合 ====		==== Node.js + Expressを使用する場合 ====
	Node.jsをインストールする。<br>		Node.jsをインストールする。<br>
	Node.jsの詳細なインストール手順は、[[インストール_-~~_Nord~~.js\|インストール_-_Node.js]]を参照すること。<br>		Node.jsの詳細なインストール手順は、[[インストール_-_Node.js\|インストール_-_Node.js]]を参照すること。<br>
	<br>		<br>
	プロジェクトディレクトリを作成する。<br>		プロジェクトディレクトリを作成する。<br>
179行目:		222行目:
	<br>		<br>
	プロジェクトディレクトリを作成して、Go Modulesを初期化する。<br>		プロジェクトディレクトリを作成して、Go Modulesを初期化する。<br>
	mkdir <任意のディレクトリ例: ~/my-api>		mkdir <任意のディレクトリ例 : ~/my-api>
	cd <作成したディレクトリ例: ~/my-api>		cd <作成したディレクトリ例 : ~/my-api>
	go mod init <モジュール名例: myapi>		go mod init <モジュール名例 : myapi>
	<br>		<br>
	必要なパッケージをインストールする。<br>		必要なパッケージをインストールする。<br>

Wiki: ページの作成:「== 概要 == HTTP APIは、HTTPプロトコルを使用して、クライアントとサーバ間でデータのやり取りを行うインターフェースである。
HTTPメソッド (GET、POST、PUT、DELETE等) を使用して、サーバ上の機能やデータへのアクセスを実現する。

HTTP APIは、必ずしもRESTの設計原則に従う必要はなく、RPC形式やカスタムエンドポイント設計等、柔軟なアプロー…」

2026-01-03T02:27:44Z

ページの作成:「== 概要 == HTTP APIは、HTTPプロトコルを使用して、クライアントとサーバ間でデータのやり取りを行うインターフェースである。<br> HTTPメソッド (GET、POST、PUT、DELETE等) を使用して、サーバ上の機能やデータへのアクセスを実現する。<br> <br> HTTP APIは、必ずしもRESTの設計原則に従う必要はなく、RPC形式やカスタムエンドポイント設計等、柔軟なアプロー…」

差分を表示