[B! swagger] griefworkerのブックマーク

SwaggerのAPI定義からPDFドキュメントを生成する

前回はASP.NET CoreのWeb API プロジェクトにSwaggerを組み込んでAPIのドキュメントをブラウザ上に表示させるところまで実行しました。これはこれで手軽にAPIの仕様を確認出来て便利なのですが、受託開発の際の納品物としてお客様に渡すには少し不便です。﹁納品は紙︵PDF︶で﹂と言われる事がまだありますよね？ブラウザに表示されているものを印刷して渡してしまっても良いかもしれませんが、それだと今ひとつ見栄えが良くないので出来ればもう少しきれいなPDF文書を自動生成したいところです。そこで調べたところ、次のような事が分かりました。 ● swagger2markup-cli を使えばSwaggerが生成するJSONファイルから静的なHTMLやMarkdown、AsciiDoc形式のドキュメントなどを生成する事が出来る。 ● asciidoctor-pdf を使えばAsciiD

griefworker 2021/04/27

リンク

ASP.NET Core Web API と NSwag を使って OpenAPI 定義を自動生成する - しばやん雑記

昔は ASP.NET で Swagger / OpenAPI 定義を出力するには Swashbuckle が定番でしたが、あまりアクティブではない時期が長かったせいか最近は NSwag を使うようにしています。今では GitHub の Star 数も Swashbuckle より NSwag の方が多くなっています。 Docs でも Swashbuckle と共に NSwag を使ったドキュメントが公開されています。機能的には Swashbuckle と NSwag で大きな差はないですが、NSwag はMSBuild 向けパッケージや CLI を使った静的な Swagger / OpenAPI 定義の生成が行えます。 Swagger / OpenAPI 正義は実行時にわざわざリフレクションを使用して生成する必要はゼロで、ビルド時やCIといったタイミングで生成できれば全く問題ない

griefworker 2020/06/01

リンク

Swagger+JSON SchemaでAPIの型をテストして開発サイクルをスピードアップさせた話 - pixiv inside

CTO兼福岡オフィス立ち上げ担当として新アプリを作っている@edvakfです。 JSON APIを開発しているとこういう問題がありがちですよね。仕様どおりにAPIの形式を作ったはずだけどなんか自信が持てないテストでいくつかのキーが存在するかの簡単なチェックはしてるつもりだけど、全部チェックするのは大変すぎる APIのControllerやViewをリファクタリングしたらレスポンスの形が変わってアプリがめっちゃクラッシュし始めたというのが怖くて誰もリファクタリングできなくなった APIドキュメントがメンテされない知らない間にレスポンスのフィールドが増えてたけどドキュメントに書いてないこれらを解決したい！と思って試行錯誤したら、スマートに解決することができました。この記事ではRailsのことについて書きますが、考え方は他の言語・フレームワークでも同じです。なお、今回使ったgemのバ

griefworker 2017/09/19

リンク

ZOZO Technologies TECH BLOG

2020-06-11 ZOZOMATのクロスプラットフォーム3D Android Objective-C Xcode iOS macOS 設計 C++ 3D ZOZOMATとは何でしょうか？オンラインで靴を購入する際に、サイズが合わないという問題を解決する仕組みです。1台のスマートフォンと紙製のZOZOMATだけで、正確に足のサイズを測れます。足をスキャンすると、高精度の3Dモデルが生成されます。最適なサイズの… ZOZOMATのクロスプラットフォーム3D 2020-06-11 近似最近傍探索Indexを作るワークフロー機械学習自動化設計マイクロサービスバックエンドインフラ Kubernetes Airflow はじめにこんにちは。ZOZO研究所のshikajiroです。主に研究所のバックエンド全般を担当しています。ZOZOでは2019年夏にAI 技術を活用した﹁類似アイテム検

griefworker 2016/11/03

swagger

リンク

Swagger 2.0 に対応した ASP.NET Web API のドキュメントを作成する - ROMANCE DAWN for the new world

この記事は、ASP.NET Advent Calendar 2015 の8日目の記事です。qiita.com 久しぶりに Swagger を使って ASP.NET Web API のドキュメントを作成してみたら、Swashbuckle の使い方が少し変わっていたので、変更点をまとめておきたいと思います。 Swagger とは Swagger については、みそさんの記事が大変分かりやすくまとまっています。 miso-soup3.hateblo.jp Swashbuckle の Version 5.x で Swagger 2.0 に対応したことで、仕様変更されました。 IIS 上で OWIN をホストさせる ASP.NET Web API を実装してみます。前準備 Visual Studio で ASP.NET MVC のプロジェクトを作成し、Web API の OWIN 関連のライ

griefworker 2015/12/12

リンク

はてなブックマーク

タグ

関連タグで絞り込む (7)

swaggerに関するgriefworkerのブックマーク (5)

お知らせ

今週のはてなブックマーク数ランキング（2024年7月第3週）

今週のはてなブックマーク数ランキング（2024年7月第2週）

はてなブックマーク透明性レポート（2024年 2月-2024年4月）

公式Twitter

キーボードショートカット一覧

はてなブックマーク

公式Twitter

はてなのサービス