サイトアクセス数: 2,500
コード埋め込みサンプル | SE WIKI
SE WIKI
Wiki
Backend
Express設計OpenAPI運用
Clean Architecture
Controllerの責務Domain Entityの責務Gatewayの責務UseCaseの責務
Sample
コード埋め込みサンプル
Sample/docs/sample/01-code-embed-sample.md

コード埋め込みサンプル

このページは、GitHubのパーマリンク(コミットSHA固定のURL)を使って、実際のリポジトリのコードを記事内に埋め込む機能の動作確認用サンプルです。

samplecode-embedGitHubで開く

コード埋め込みサンプル

このページは、GitHubのパーマリンク(コミットSHA固定のURL)を使って、実際のリポジトリのコードを記事内に埋め込む機能の動作確認用サンプルです。

Expressサーバーのエントリーポイント

somadevfat/ecsite-express-backend の src/index.ts を、コミット固定のパーマリンクで埋め込んでいます。GitHub上でファイルを開き、行を選択して y キーを押すとこの形式のURLをコピーできます。

somadevfat/ecsite-express-backend — src/index.ts#L1-L11

import express from 'express';

const app = express();

app.get('/', (_req, res) => {
  res.send('Hello World!');
});

const port = Number(process.env.PORT) || 3000;
app.listen(port, () => {
  console.log(`Server running on http://localhost:${port}`);

このように、解説文の直後に実コードを差し込めます。#L1-L11 の部分で行範囲を指定しているので、ファイルの一部だけを抜き出すこともできます。

存在しないファイルを指定した場合

エラーハンドリングの確認用に、わざと存在しないパスも埋め込んでおきます。

[embed error] Failed to fetch somadevfat/ecsite-express-backend/does-not-exist.ts (status=404)
目次
Expressサーバーのエントリーポイント存在しないファイルを指定した場合