サーバ - REST API - 版の履歴

Wiki: /* Python + FastAPIを使用する場合 */

2025-01-01T08:01:04Z

Python + FastAPIを使用する場合

@@ 277行目: / 277行目: @@
 == APIの基本的な実装 ==
 ==== Python + FastAPIを使用する場合 ====
   <syntaxhighlight lang="python">
   # main.pyファイル
@@ 296行目: / 302行目: @@
   async def create_item(item: Item):
      return item
   </syntaxhighlight>
 <br><br>
 == HTTPS対応 ==

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

2025-01-01T07:47:51Z

監視とログ管理

← 古い版		2025年1月1日 (水) 16:47時点における版
378行目:		378行目:

	sudo wget -q -O /usr/share/keyrings/grafana.key https://apt.grafana.com/gpg.key		sudo wget -q -O /usr/share/keyrings/grafana.key https://apt.grafana.com/gpg.key
			<br>
			MariaDBを使用している場合は、MySQLエクスポータ (Prometheus向け) をインストールする。<br>
			sudo apt install prometheus-mysqld-exporter
			<br>
			MySQLエクスポータ (Prometheus向け) の設定ファイルを作成する。<br>
			sudo vi /etc/default/prometheus-mysqld-exporter
			<br>
			# /etc/default/prometheus-mysqld-exporterファイル

			# 例: DATA_SOURCE_NAME="myapi_user:your_password@(localhost:3306)/"
			DATA_SOURCE_NAME="<データベースユーザ名>:<データベースユーザのパスワード>@(localhost:<MariaDBのポート番号>)/"
	<br><br>		<br><br>

Wiki: /* データベースの設定 */

2025-01-01T07:37:17Z

データベースの設定

@@ 167行目: / 167行目: @@
 <br>
 データベースを作成する。<br>
-  sudo -u postgres createdb myapi_db
+  sudo -u postgres createdb   <任意のデータベース名>
-  sudo -u postgres createuser myapi_user
+  sudo -u postgres createuser <任意のデータベースユーザ名>
 <br><br>

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

2025-01-01T06:29:36Z

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

@@ 88行目: / 88行目: @@
 <br>
 Pythonと仮想環境の設定を行う。<br>
-  python3 -m venv venv
+これにより、プロジェクトごとに独立したPython環境を作成することができる。<br>
 <br>
- vi ~/.profile
+Pythonの仮想環境をアクティベートする。<br>
   source venv/bin/activate
 <br>
 必要なPythonライブラリをインストールする。<br>
   pip install fastapi uvicorn sqlalchemy
 <br>
 ==== Node.js + Expressを使用する場合 ====

Wiki: /* Python + FastAPIを使用する場合 */

2025-01-01T06:18:12Z

Python + FastAPIを使用する場合

← 古い版		2025年1月1日 (水) 15:18時点における版
79行目:		79行目:
	Pythonと仮想環境をインストールする。<br>		Pythonと仮想環境をインストールする。<br>
	# RHEL		# RHEL
	sudo dnf install python3 python3-pip python3-~~venv~~		sudo dnf install python3 python3-pip python3-virtualenv

	# SUSE		# SUSE

Wiki: /* 概要 */

2025-01-01T06:13:44Z

概要

@@ 1行目: / 1行目: @@
 == 概要 ==
 <br>
 REST APIサーバを構築・運用する場合は、以下に示す事柄に注意する。<br>

Wiki: /* Let's Encryptを使用する場合 */

2025-01-01T05:49:18Z

Let's Encryptを使用する場合

← 古い版		2025年1月1日 (水) 14:49時点における版
120行目:		120行目:

	# SUSE		# SUSE
	sudo zypper install ca-~~certificates~~ python3-certbot		sudo zypper install python3-certbot python3-certbot-nginx

	# Raspberry Pi		# Raspberry Pi

Wiki: /* 概要 */

2025-01-01T05:44:42Z

概要

← 古い版		2025年1月1日 (水) 14:44時点における版
1行目:		1行目:
	== 概要 ==		== 概要 ==
			<br>
			REST APIサーバを構築・運用する場合は、以下に示す事柄に注意する。<br>
			* 定期的なバックアップの実施
			* セキュリティアップデートの適用
			* アクセスログの監視
			* レート制限の実装
			* 適切なエラーハンドリング
			* データベースの最適化
			* APIドキュメントの作成と管理
	<br><br>		<br><br>

Wiki: ページの作成:「== 概要 ==

== サーバ環境のインストール == まず、システムを更新を行う。
# RHEL sudo dnf update # SUSE sudo zypper update # Raspberry Pi sudo apt update sudo apt upgrade
次に、Linuxサーバに必要な基本環境をインストールする。
# RHEL sudo dnf install curl wget git # SUSE sudo zypper install curl wget git # Raspberry Pi sudo apt install curl wget git build-essential

=…」

2025-01-01T05:43:01Z

ページの作成:「== 概要 == == サーバ環境のインストール == まず、システムを更新を行う。 # RHEL sudo dnf update # SUSE sudo zypper update # Raspberry Pi sudo apt update sudo apt upgrade 次に、Linuxサーバに必要な基本環境をインストールする。 # RHEL sudo dnf install curl wget git # SUSE sudo zypper install curl wget git # Raspberry Pi sudo apt install curl wget git build-essential =…」

新規ページ

== 概要 ==
 

== サーバ環境のインストール ==
まず、システムを更新を行う。 
# RHEL
sudo dnf update

# SUSE
sudo zypper update

# Raspberry Pi
sudo apt update
sudo apt upgrade
 
次に、Linuxサーバに必要な基本環境をインストールする。 
# RHEL
sudo dnf install curl wget git

# SUSE
sudo zypper install curl wget git

# Raspberry Pi
sudo apt install curl wget git build-essential
 

== 開発言語とフレームワークの選択 ==
==== Python + FastAPIを使用する場合 ====
Pythonと仮想環境をインストールする。 
# RHEL
sudo dnf install python3 python3-pip python3-venv

# SUSE
sudo zypper install python3 python3-pip python3-virtualenv

# Raspberry Pi
sudo apt install python3 python3-pip python3-venv
 
Pythonと仮想環境の設定を行う。 
python3 -m venv venv
 
vi ~/.profile
 
# ~/.profileファイル

source venv/bin/activate
 
必要なPythonライブラリをインストールする。 
pip install fastapi uvicorn sqlalchemy
 
==== Node.js + Expressを使用する場合 ====
Node.jsをインストールする。 
Node.jsの詳細なインストール手順は、[[インストール_-_Yarn#NordJS|インストール_-_Yarn]]を参照すること。 
 
プロジェクトディレクトリを作成する。 
mkdir <任意のディレクトリ例: ~/my-api>
cd <作成したディレクトリ例: ~/my-api>
 
プロジェクトに必要なJavaScriptライブラリをインストールする。 
npm init
npm install express body-parser cors
 

== データベースの設定 ==
==== PostgreSQLを使用する場合 ====
PostgreSQLをインストールする。 
# RHEL
sudo dnf install postgresql libpq5

# SUSE
sudo zypper install postgresql libpq5

# Raspberry Pi
sudo apt install postgresql postgresql-contrib
 
データベースを作成する。 
sudo -u postgres createdb myapi_db
sudo -u postgres createuser myapi_user
 

== APIの基本的な実装 ==
==== Python + FastAPIを使用する場合 ====
<syntaxhighlight lang="python">
# main.pyファイル

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class Item(BaseModel):
name: str
description: str = None

@app.get("/items")
async def read_items():
return {"items": []}

@app.post("/items")
async def create_item(item: Item):
return item
</syntaxhighlight>
 

== HTTPS対応 ==
==== Let's Encryptを使用する場合 ====
Certbotをインストールする。 
# RHEL
sudo dnf install ca-certificates python3-certbot

# SUSE
sudo zypper install ca-certificates python3-certbot

# Raspberry Pi
sudo apt install certbot python3-certbot-nginx
 
SSL証明書を取得する。 
sudo certbot --nginx -d <ドメイン名例: example.com>
 

== リバースプロキシの設定 ==
==== Nginxを使用する場合 ====
<syntaxhighlight lang="nginx>
# /etc/nginx/sites-available/myapiファイル

server {
listen 80;
server_name yourdomain.com;

location / {
proxy_pass http://localhost:8000;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
}
}
</syntaxhighlight>
 

== Systemdサービスファイルの作成 ==
<syntaxhighlight lang="ini>
# /etc/systemd/system/<任意のサービス名>.serviceファイル

[Unit]
Description=<サービスファイルの説明>
After=network.target

[Service]
User=<実行する任意のユーザ名>
WorkingDirectory=<REST APIのプロジェクトディレクトリ例: /home/<ユーザ名>/my-api>
ExecStart=/<uvicorn実行ファイルのパス> main:app --host <ホスト名またはIPアドレス> --port <ポート番号>
# 例: ExecStart=/home/myapi_user/my-api/venv/bin/uvicorn main:app --host 0.0.0.0 --port 8000
Restart=always

[Install]
WantedBy=multi-user.target
</syntaxhighlight>
 

== ファイヤーウォールの設定 ==
==== Firewalldの場合 ====
sudo firewall-cmd --permanent --add-service=http
sudo firewall-cmd --permanent --add-service=https

sudo firewall-cmd --reload
 
==== UFWの場合 ====
sudo ufw allow 80/tcp
sudo ufw allow 443/tcp

sudo ufw enable
 

== 監視とログ管理 ==
[https://github.com/prometheus/prometheus PrometheusのGithub]にアクセスして、Prometheusをインストールする。 
ダウンロードしたファイルを解凍する。 
tar xf prometheus-<バージョン>.tar.gz
 
Grafanaをインストールする。 
sudo apt install apt-transport-https
sudo apt install software-properties-common

sudo wget -q -O /usr/share/keyrings/grafana.key https://apt.grafana.com/gpg.key
 

== CI/CD環境の構築 ==
==== GitLabを使用する場合 ====
<syntaxhighlight lang="yaml">
# .gitlab-ci.ymlファイル

stages:
- test
- deploy

test:
stage: test
script:
- pip install -r requirements.txt
- pytest

deploy:
stage: deploy
script:
- ssh user@yourserver 'cd /path/to/api && git pull && systemctl restart myapi'
only:
- master
</syntaxhighlight>
 

{{#seo:
|title={{PAGENAME}} : Exploring Electronics and SUSE Linux | MochiuWiki
|keywords=MochiuWiki,Mochiu,Wiki,Mochiu Wiki,Electric Circuit,Electric,pcb,Mathematics,AVR,TI,STMicro,AVR,ATmega,MSP430,STM,Arduino,Xilinx,FPGA,Verilog,HDL,PinePhone,Pine Phone,Raspberry,Raspberry Pi,C,C++,C#,Qt,Qml,MFC,Shell,Bash,Zsh,Fish,SUSE,SLE,Suse Enterprise,Suse Linux,openSUSE,open SUSE,Leap,Linux,uCLnux,Podman,電気回路,電子回路,基板,プリント基板
|description={{PAGENAME}} - 電子回路とSUSE Linuxに関する情報 | This page is {{PAGENAME}} in our wiki about electronic circuits and SUSE Linux
|image=/resources/assets/MochiuLogo_Single_Blue.png
}}

__FORCETOC__
[[カテゴリ:RHEL]][[カテゴリ:SUSE]][[カテゴリ:Raspberry_Pi]][[カテゴリ:Web]]