こんにちは、井上です。 「Swaggerで始めるモデルファーストなAPI開発」を見て興味を持ったので、Swaggerをちょっと触ってみたのですが、すぐに、これ1ファイルの YAMLファイルでメンテナンスするの超しんどくない？と感じました。 なので、分割する方法を調べてみました。で、みつけたのが下記エントリ。 How to split a Swagger spec into smaller files 方法としては、別々のファイルに書いた定義を $ref で参照しておき、それを json-refs でマージして1ファイルに戻すというやり方のようです。 下記のような YAML ファイルを、 swagger: '2.0' info: version: 0.0.0 title: Simple API paths: /foo: get: responses: '200': description:
実は、bootstrapの知識だけでは足りません（涙） 本気でweb制作を仕事にしたいなら、現場で通用する実践的なスキルを「短期集中」で身につけましょう。 【独学 vs スクール】メリットとデメリットを比べて、おすすめの学習方法もお伝えします。 続きはこちら Bootstrap、使ってますか？ 便利ですよね。その便利さを物語るように、本当にいろいろなサイトで利用されてます。 ネットで配布されてるWordPressのテーマやHTMLテンプレートのベースに使われていることも多いです。気づいてないうちに使ってしまっているひとも、たくさんいることでしょう。 今回は、便利なのだけど、使いこなすには少し理解が難しい「bootstrapのグリッドシステム」について解説します。bootstrapでレスポンシブデザインを作るとき、欠かせないテクニックです。 グリッドシステムは、頭で理解しようとせず、目で見て
using System; using System.Collections.Generic; using System.Linq; using System.Threading.Tasks; using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.Hosting; using Microsoft.AspNetCore.HttpsPolicy; using Microsoft.AspNetCore.Mvc; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Hosting; using Microsoft.Extensions.Loggin
前回は簡単な Web API の Swagger definition を書いただけで終わってしまったけど、 ここからが本題。 やりたいのは、Swagger definition からクライアントとサーバーのソースコード生成すること。 そのためのツールとして swagger-codegen が提供されている。 http://swagger.io/swagger-codegen/swagger.io お試しなので、Homebrew や mvn を使わずに直接 jar をダウンロードしてしまおう。 http://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.1.5/swagger-codegen-cli-2.1.5.jar 前回の Swagger definition を sample_api.yml として保存し、 まずは A
例えばカスタムヘッダでそこに認証用のキーを埋め込んでほしい場合などの書き方。OAuthとかBasic認証はあるのだけど、そういうポピュラーなものではなくオリジナルをやりたい場合の例。 書き方 securitySchemes にtypeを apikey にした情報を定義する 利用したいエンドポイントで secure の項目を追加して指定する 実例 /user のエンドポイント に 認証用のコードとしてSECRETHEADERCODEを入れるようにヘッダに指定したい場合 securitySchemesの定義 以下の用に定義する components: securitySchemes: API_SECRETCODE: type: apiKey description: ヘッダに乗せるシークレットキー in: header name: SECRETHEADERCODE エンドポイントに追加 以下の
お仕事で「APIの仕様書をすわっがーで作ってね」って言われました、既存の仕様書はYAMLファイルになっているのですが・・・何？Swaggerって？ Swaggerは、OpenAPI仕様に基づいてREST APIの仕様書作成から構築を助けてくれるツールです。 OpenAPIは、REST APIの記述フォーマットです。 Swagger3.0は、OpenAPI？ ブラウザで仕様書を見て書けます。 実行もできます。 GitにあるSwaggerのファイルをプレビューできるChrome拡張機能があるらしいです。 Serversを書く 認証を書く Bearer スキームを書く 共通で使うオブジェクトや構造の定義を書く リクエストを書く パラメータを定義する レスポンスを書く レスポンスのexampleを複数定義する YAMLファイルに保存する Swaggerは、OpenAPI仕様に基づいてREST AP
ASP.NET Core 2.2 で、セッション変数にClassやListなどのオブジェクトを保持したい場合、Session拡張メソッドを使うとシンプルなソースコードになる。 セッション変数のKey/Valueが増え過ぎて、メンテナンス不能になるのを防ぐ為には必須。 Session拡張メソッドを、ジェネリック指定でjson形式にシリアライズし保持する。 public static class SessionExtensions { public static void Set<T>(this ISession session, string key, T value) { session.SetString(key, JsonConvert.SerializeObject(value)); } public static T Get<T>(this ISession session, st
Visual Studio CodeでWebアプリケーションを作成する場合のASP.NET MVCプロジェクトの作成方法、プロジェクト参照の設定方法を紹介します。 執筆時点のASP.NET Coreのバージョンは2.1です。 Cで開発する際にVisual Studioが不要になりましたが、VSCodeではGUIでこの辺りの操作は出来ず、dotnetコマンドで設定する必要があります。 プロジェクトの作成方法 事前に.NET Coreを入手 MVCの開発には.NET Coreのランタイムが必要にあります。 Visual Studio等が入っていると一緒に付いてきたりしますが、入っていない方はインストールしましょう。 ■.NET Core https://www.microsoft.com/net/download ターミナルの表示 表示→統合ターミナル(Ctrl+@)からターミナルを表示します
入門 Docker¶ About¶ Dockerの入門からプロダクションで活用するプラクティスについてのドキュメントです。 プロダクションへ導入するために必要なDockerの概要から設計までをなるべく最短経路で学ぶことが目的です。 想定する読者層¶ WebAPIのようなサーバーサイドのプログラミングをしたことがある Dockerをこれからプロダクション環境へ導入してみたいと考えている初学者 Version¶ Docker 18.09.3 docker-compose 1.23.2 必要な環境¶ Docker Hub のアカウント Docker公式レジストリ Play with Docker DockerをWeb上で動かせる環境 Play with Dockerを起動するのに前述のDockerHubアカウントが必要 Docker for Mac(Windows)の場合VMが間に挟まり挙動が異
環境 .NET 6 / C# 10.0 ASP.NET Core 6 先にまとめ ASP.NET Core 5以前では Startup というクラスがStartup.cs にありました。 ASP.NET Core 6では最小ホスティングモデル (minimal hosting model) が登場し、StartupクラスもなければProgramクラスすら一見すると無くなりました。 WebApplicationFactory を使うと、コントローラにHTTPリクエストを投げるようなテストを簡単に記述できますが、StartupやProgramが「無くなって」しまうと、ジェネリック型引数に指定するものに窮します。 3つの解決策を調べました。新規案件については、個人的には3番目の案が良いと考えます。 Startup.csを以前通り定義する。 5以前からのアップグレード組であれば最善に思います。 本
![[ASP.NET Core 6] WebApplicationFactoryの利用の互換性が失われることに対処する](https://cdn-ak-scissors.b.st-hatena.com/image/square/e080208df8ebc434892f869a01e359c3f41fa1e5/height=288;version=1;width=512/https%3A%2F%2Ffanyv88.com%3A443%2Fhttps%2Fres.cloudinary.com%2Fzenn%2Fimage%2Fupload%2Fs--MYl9l25H--%2Fc_fit%252Cg_north_west%252Cl_text%3Anotosansjp-medium.otf_55%3A%25255BASP.NET%252520Core%2525206%25255D%252520WebApplicationFactory%2525E3%252581%2525AE%2525E5%252588%2525A9%2525E7%252594%2525A8%2525E3%252581%2525AE%2525E4%2525BA%252592%2525E6%25258F%25259B%2525E6%252580%2525A7%2525E3%252581%25258C%2525E5%2525A4%2525B1%2525E3%252582%25258F%2525E3%252582%25258C%2525E3%252582%25258B%2525E3%252581%252593%2525E3%252581%2525A8%2525E3%252581%2525AB%2525E5%2525AF%2525BE%2525E5%252587%2525A6%2525E3%252581%252599%2525E3%252582%25258B%252Cw_1010%252Cx_90%252Cy_100%2Fg_south_west%252Cl_text%3Anotosansjp-medium.otf_37%3Ashimat%252Cx_203%252Cy_121%2Fg_south_west%252Ch_90%252Cl_fetch%3AaHR0cHM6Ly9zdG9yYWdlLmdvb2dsZWFwaXMuY29tL3plbm4tdXNlci11cGxvYWQvYXZhdGFyLzMxOTgyYTAyNDEuanBlZw%3D%3D%252Cr_max%252Cw_90%252Cx_87%252Cy_95%2Fv1627283836%2Fdefault%2Fog-base-w1200-v2.png)
OpenAPI の定義があることのメリットの一つは自動生成だと自分では勝手に思っているんだけど、ちょっとその感覚がいまいちなのかと揺らいできた。 Web API 側 ASP.NET Core + Client 側 TypeScript でやっている場合 例えば class Member { public int Id { get; } puiblic int Name { get; } } みたいな定義があり、これを Controller 側では [ProducesResponseType(typeof(List<Member>), 200)] public IActionResult GetMembers() みたいに書くとする。（手で書いてるので間違いはあるかもしれないが、雰囲気で） これの swagger 定義はだいたい以下のようになる。（ASP.NET Core で出力する場合はも
本記事の対象 ASP.NET Core Web APIの基本的な仕組みを理解したい C#、REST APIの基本的な知識がある 環境 Windows 11 Visual Studio 2022 .NET 8 プロジェクトの作成と実行 Visual Studioを起動したら、新規プロジェクトの作成画面を開き、「ASP.NET Core Web API」を選択します。 プロジェクト名はチュートリアルと同じ「TodoApi」にしました。 ターゲットフレームワークには「.NET 8.0(長期的なサポート)」を選択します。その他の項目はデフォルトのままでOKです。 プロジェクトの作成が完了したら、「Ctrl＋F5」でデバッグなしで実行してみましょう。 もし、次の画面が表示された場合は「はい」を選択して証明書をインストールしてください。 ブラウザが起動し、以下のようなSwagger UIのページが表示
はじめに なぜこんな記事を書こうと思ったかというと、認証・認可について僕がなあなあになっている気がしたので、改めて自分の中で整理したかった為です。 認証 (Authentication) あるウェブサイトにユーザがログインした際に誰なのかを確認することを指します。 本人確認をイメージすると分かりやすいかもです。 認可 (Authorization) 認証したユーザに対して、リソースのアクセス権限をどこまで与えるか決定することです。 フェデレーテッドログイン これは、例えばあるサービスがあった場合にそのサービス以外が管理するIDを利用してログインする方法です。 実装パターン 以下に実装パターンをいくつか紹介しますが、だいたい今はOAuth 2.0かOpenID Connect(別記事で書きます。)ですねw シングルサインオン シングルサインオンは、各システム間のアカウント管理を別々に行わず、
はじめに .Net Framework 4.8がリリースされて、.Net Frameworkが遂に、アップデート停止になりました。 (バグ修正やセキュリティ修正は、継続されます。2020/12/17現在) 早急に対策が必要なわけではありませんが、.Net Coreへのマイグレーションを少しづつ進める必要性が高くなったというサインだと思います。 旧システムの.NET 5へのマイグレーションを進めるなかで、調査したSwagger設定を備忘録として、書き記します。 Swaggerとは Swaggerは、Wordnik Society社が、自社のAPIドキュメントの自動化のために作成したツールが源流になっているようです。 Apache 2.0オープンライセンスによって公開されていて、Apigee、Intuit、Microsoft、IBMなどに採用されたことで、広く知られるようになっていきます。 現
はじめに extablefilterは、テーブルのフィルタリングを画面実装したいときに便利なjqueryプラグインです。 「input入力すると、テーブルが動的に絞り込みされる」実装を実現します。 あまりにもよくお世話になる(この時代でもなお)ので備忘録を兼ねて紹介させてください。 MITライセンスです。 使い方 シンプルな例 jquery読み込み extablefilterを読み込み inputやtableを含むHTMLを書く input formとtableに対してexTableFilterを実行 という順番になります。以下が例です。 <!-- スクリプト読み込み --> <!-- The integrity and crossorigin attributes are used for Subresource Integrity (SRI) checking --> <script
2022年10月3日(月) 登 大 遊 * Daiyuu Nobori, Ph.D. テクノロジーベースの規制改革推進委員会（第１回） 提出資料 テクノロジーマップ、技術カタログ の在り方について * 所属: 独立行政法人 情報処理推進機構 (IPA) 等 技術情報を日本組織に向けて発信し、組織内で技術が実際に仕事に使われるまでには 1 登 大遊 提出資料 1. たとえ良い技術であっても、外部から組織に技術情報を注入し、業務利用を促すことは、とても難 しい。なぜならば、組織には、従前の動きをひたすら繰り返す性質があり、変化を避けたがり、堅い外 殻により、外からの異物を排除するためである (これはもちろん、セキュリティ上必要な防衛機構である)。そこで、 良い技術の情報を単純に発信しても、跳ね返される。 外 内 ↑強固なファイアウォール (FW) 組織 従来手法 従来手法 従来手法 従来手法
基本的な書き方は「swaggerの基礎。swaggerの設定ファイルの書き方とか」を参照 この記事は上記の内容を前提に、補足程度の情報を記載。 追加があったら都度、追記するかもしれない。 サンプルを記載する そのまんま。swagger-editorのプレビューやswagger-UIのAPI一覧でサンプルを見ることができる。 ぱぱっと内容を把握するのに便利。 「examples:」から諸々を記載。以下の例はSwagger-editorのサンプルにある、instagramのyamlから抜粋して加工してある。 paths: /users/{user-id}: parameters: - $ref: '#/parameters/user-id' get: security: - key: [] - oauth: - basic tags: - Users description: Get basi
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
