goa tips : swagger-ui を使って手っ取り早く API を試す - 押してダメならふて寝しろ
はじめに 折角 API を作ったら，簡単に試して，仕様も俯瞰的に確認したいものです． そんなわけで，今回は開発環境で使える swagger-ui の tips です． swagger-ui は swagger ドキュメントを閲覧するためのサービスを提供してくれます． しかも API コンソールがついているので，ドキュメントを確認しながらその場で API を試すことが出来ます． github.com これをサービスとして立ち上げて，goa で生成した swagger ドキュメントをセットするというのもまどろっこしいので， goa で生成したサービスを立ち上げると，swagger-ui も一緒にサービスするようにしてしまおう．というのが今回の目標です． swagger-ui を配置 swagger-ui の distフォルダをコピーしてきます． 以下の説明では，作業ディレクトリの swagge
Swagger定義ファイルを分割する | DevelopersIO
Swagger用ファイルを分割して記述しよう Swaggerとは Swaggerとは言語に依存しないREST APIのインターフェース仕様とそれに関連するツール/ライブラリのことです。 RESTful APIの記述標準化を目指している、MS/Google/IBMなどが参加しているグループ、 Open API Initiativeでは、APIの記述のためにSwaggerが採用されています。 Swaggerは以下のようなツールから構成されています。 Swagger UI - swagger specをパースしてAPIドキュメント化するツール Swagger Codegen - swaggerの定義ファイルからプログラムコードを生成するツール Swagger Editor - オンラインで使用できるSwaggerエディタ 普通にswaggerの記述をする まずは下記のように、普通にswagger
The History of etcd | CoreOS
For customersCustomer supportSubscription managementSupport casesRed Hat Ecosystem CatalogFind a partnerFor partnersPartner portalPartner supportBecome a partner Try, buy, & sellRed Hat MarketplaceRed Hat StoreContact salesStart a trialLearning resourcesDocumentationTraining and certification Hybrid cloud learning hubInteractive labsLearning communityRed Hat TVOpen source communitiesAnsibleGlobal
[Java] Self-Documented Services Using JAX-RS Analyzer
Oracle Blogsの主としてテクノロジー製品のエントリを日本語でご紹介します（オリジナルのエントリを投稿することもあります）。厳密性をご所望の方は原文をどうぞ。よい内容でしたら原文に対し、"Good Entry, thanks!"でもいいので、是非コメントお願いします（Typoや誤訳はコメント欄からどうぞ）。なお、このエントリは個人の見解であり、所属する会社の公式見解ではありません。また、エントリ内でご紹介している製品・サービスは国内導入時期が未定の場合もありますのでご了承下さい。 Good entries on Oracle Blogs are put into Japanese. Mainly this blog covers technology products. Opinions expressed in this blog is my personal one and d
![[Java] Self-Documented Services Using JAX-RS Analyzer](https://cdn-ak-scissors.b.st-hatena.com/image/square/8ac086ca3bad2e09f6c495f29e13e10bd9fee588/height=288;version=1;width=512/https%3A%2F%2Fblogger.googleusercontent.com%2Fimg%2Fb%2FR29vZ2xl%2FAVvXsEiYAs8lt8YxH3JT46NHqNTzLUYXiwVVGg6e0o8U3HUwjaov3ljUMya4nrnzfgGWUSwPy8jy8qx4a35ivSspnWJ-MkZS9Of0az07BvqI3GFKveaA4aRonrEjA3N0nJgRaNqPEhAmn3wMfNM%2Fw1200-h630-p-k-no-nu%2FJAX-RS_Analyzer.PNG)
swaggerでAPIドキュメントを書いたらめっちゃはかどった話 - kaz29
Swaggerは、REST APIの仕様とそれに関連するツール群の総称です。REST APIの仕様を定義したJSONファイル(Swagger Spec)を軸に以下のようなツールから構成されています。 Swagger UI - Swagger Spec から動的にAPIドキュメントを生成するツール Swagger Editor - Swagger Specのエディタ Swagger Codegen - Swagger Specからクライアントのコードを生成するツール 最近では、Open API InitiativeがAPIの記述のためにSwaggerを採用して話題になりました。 www.publickey1.jp APIドキュメントのメンテは結構面倒 一般的にAPIの仕様書は、古くはExcel/Wordなどを使ったり、最近ではWikiやMarkdown形式で記述したりなどプロジェクトによって
僕が考えた最強のAPIドキュメント生成 - 銀の人のメモ帳
2023 追記 2023 年現在では、以下の文章では採用を見送っている OpenAPI を使えば OK という雰囲気です。 Web APIの設計 作者:Arnaud Lauret翔泳社Amazon TL; DR ドキュメント生成にはkevinrenskers/raml2htmlを使った ドキュメントはRAML - RESTful API modeling languageで書いた RAMLにはJSON SchemaとJSONを記載できる APIで返ってくるJSONはRailsアプリのrequest specでJSON Schemaを使ってテストした JSON Schemaはr7kamura/json_worldで生成した ドキュメントに載せる例示のJSONもJSON Schemaからgin0606/screijiを使って生成した 上記の方法だとリクエストパラメタとドキュメントの整合性を担保
Swaggerで始めるモデルファーストなAPI開発
This document summarizes a microservices meetup hosted by @mosa_siru. Key points include: 1. @mosa_siru is an engineer at DeNA and CTO of Gunosy. 2. The meetup covered Gunosy's architecture with over 45 GitHub repositories, 30 stacks, 10 Go APIs, and 10 Python batch processes using AWS services like Kinesis, Lambda, SQS and API Gateway. 3. Challenges discussed were managing 30 microservices, ensur
【技術トレンド】Technology Radar 2015年5月版を読み解く【ThoughtWorks】 | DevelopersIO
よく訓練されたアップル信者、都元です。ThoughtWorks社のTechnology Radarをご存知でしょうか。 Technology Radar ThoughtWorks社はグローバルに展開するソフトウェア開発やコンサルティングを行っている会社です。オブジェクト指向やアジャイル開発に数多くの貢献をしている、マーティン・ファウラー氏が所属していることでも有名です。 この会社では年に1〜2回、最近の技術トレンドとなるキーワードをカテゴリ毎にいくつかピックアップし、評価した情報を発信しています。 Technology Radar（以下TR）では各キーワードを「blip」、カテゴリを「quadrant」、評価した結果の位置づけを「ring」と呼んでいます。 quadrants（カテゴリ） quadrantsは図における上下左右の4象限で表されています。 Languages & Framew
Qiita API v2のJSON Schemaを公開しました - Qiita Blog
こんにちは、r7kamura です。 最近は主にイカとして活動しており、カラフルな墨を掛け合う日々を送っています。 さて、QiitaおよびQiita Teamでは、Qiita API v2としてデータを操作するためのREST APIを公開しています。これまで開発者向けに APIドキュメント を提供していましたが、今回は主に機械向けのインターフェースとして、JSON Schemaで記述したREST APIのスキーマ定義 (以下スキーマ) を公開することになりました。具体的には、JSON Hyper-Schema draft v4 を利用して定義されています。 http://qiita.com/api/v2/schema Qiita API v2のスキーマの説明Qiita API v2のスキーマの構成について簡単に説明します。スキーマは http://qiita.com/api/v2/sche
SwaggerでREST APIドキュメントを生成する - ka-ka_xyzの日記
2016/06/24 追記 www.itmedia.co.jp 今のところまだこの脆弱性の対策版がリリースされていないので注意。 だいぶ昔にJersey（JAX-RS参照実装）についての記事を書いてからずっと気になっていたんですが、せっかくアノテーションを使ってURLとメソッドとの間にヒモ付が出来たのに、このアノテーション情報からJavadoc的なAPIドキュメントを生成する方法は無いものかと思っていました。 （追記: いやjerseyでwadlを生成できるけどレスポンスのJSONやXMLの構造については何も情報が出ないので・・・） JAX-RSでは今のところAPIドキュメント生成についてはカバーして無いようですが、最近仕事でREST APIドキュメントを生成出来ないかという話が出てきたので調べてみるとSwaggerというREST APIドキュメント生成フレームワーク？が有るようなので触っ
GitHub - swagger-api/swagger-editor: Swagger Editor
⏰️ Looking for the next generation version of Swagger Editor? SwaggerEditor is now released under two major release channels: SwaggerEditor@4 - released from master branch and deployed at https://editor.swagger.io/ SwaggerEditor@5 - released from next branch and deployed at https://editor-next.swagger.io/ Only SwaggerEditor@5 supports OpenAPI 3.1.0. SwaggerEditor@4 will not receive OpenAPI 3.1.0 s
APIドキュメントを書くのが楽になるツールまとめ - Qiita
さいきんREST APIのドキュメントを書いていて、wiki使うのだるいし他に良い方法ないかな〜と調べてた時に見つけたツール群をまとめてみます。 追記: こちらも便利そうなので参考にどうぞ。 REST APIドキュメント作成ツールはapiary.ioが決定版かもしれない - Qiita swagger Swagger: A simple, open standard for describing REST APIs with JSON | Reverb for Developers デモ: Swagger UI ソースコード中にAPIの概要を書いておくと、それを元にドキュメントを自動生成してくれる。wikiやmarkdownで書くのと決定的な違いは、↓のようにドキュメント上のformからAPIコールを試すことができる点。 様々な言語のWAFに対応したライブラリも開発されてる。 Home ·
API Documentation & Design Tools for Teams | Swagger
API Development forEveryone Simplify your API development with our open-source and professional tools, built to help you and your team efficiently design and document APIs at scale. Find your toolRead the docs Trusted by Empowering API Development Streamline your workflow with unparalleled API specification support Swagger places API specifications such as OpenAPI, AsyncAPI, and JSON Schema at the
はてな京都オフィスで、Netflix Meetupを開催しました - Hatena Developer Blog
こんにちは。アプリケーションエンジニアのid:daiksyです。 この記事ははてなエンジニアアドベントカレンダーの2日目です。 今日は、12月1日にはてな京都オフィスで開催された、Netflix Meetup in Kyotoの模様をご紹介しようと思います。 経緯 ある日、Netflix社のJason Swartz(@swartzrock)さんから、日本のScalaコミュニティ宛に相談がありました。その内容は、「今度日本に遊びに行く予定で、東京と京都に滞在するんだけど、よい機会だから日本のエンジニアとMeetupなどやれないか」というものでした。 この相談を受けたScalaコミュニティから、ScalaMatsuriのスタッフをしていた関西のエンジニアとの縁もあって「京都で誰か手を挙げません？」との打診があり、またとない機会なので、はてなの京都オフィスのセミナールームを提供することになりまし
REST APIを記述せよ！Swagger紹介 #apijp - Groovyラボ
Web API Advent Calendar 2014、初日はSwaggerを紹介します。 SwaggerはReverbによって開発された、RestfulなAPIを記述する標準仕様です。APIを機械可読な形で記述することは、ドキュメント生成やツール開発、さまざまな形での自動化に非常に重要です。好き嫌いはともかく、SOAPにはWSDLという統一標準がありましたが、RESTには本質的にそういった標準がないため、類似するさまざまな仕様が開発されてきました。Swaggerはその中でも最も有望なものの一つだと思います。 1. 特徴 記述はJSONでシンプル。ミニマム定義の例： { "swagger": "2.0", "info": { "version": "1.0.0", "title": "petstore" }, "paths": { "/users": { "get": { "respon
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
マイクロサービス内の依存性地獄をコントロールするには - Michael Bryzak氏の講演より
API Design & Testing State of the Art