documentationjs + add-text-to-markdownでREADME.mdのAPIリファレンスを自動更新
documentationjs + add-text-to-markdownでREADME.mdのAPIリファレンスを自動更新 documentationjsはJSDocからドキュメントを生成できるツールで、ES2015以降のコードにも対応しています。 (TypeScriptは対応してないようです) 以前はMarkdownへの出力が難しかったのですが、いつのまにかdocumentation build -f mdでMarkdownでのAPIドキュメントが生成できるようになっていました。 これを使うことで、ライブラリを書いてそのJSDocからドキュメントを生成して、READMEのUsageセキュクションを自動的に更新できるようになっています。 以前もできたのですが、かなりトリッキーなテーマを書いたりしないといけませんでした。(後stdoutへの出力がなかった気がします) –theme for
VBA-Web - VBA用のWebライブラリ
今はWeb APIやRESTfulといったキーワードを無視できなくなっています。それはExcelやAccessでも同じです。しかしVBAでやったことがある人は分かりますが、XML HTTP Requestで作るのはなかなか面倒です。 そこで使ってみたいのがVBA-Webです。VBAがインターネット上のリソースとデータの送受信をするのに最適なライブラリです。 VBA-Webの使い方 例えばGoogleマップの機能を使って二点間の距離を算出します。 他にもGoogle Analyticsのデータを取得することも。 VBA-WebはGET/POSTだけでなく、PUT/DELETEも使えます。Cookieにも対応し、JSONも扱えます。OAuth2認証にも対応していますので、最近のWeb APIであれば問題なく利用できるでしょう。 VBA-WebはVBA製のオープンソース・ソフトウェア（MIT L
REST API仕様からAPIクライアントやスタブサーバを自動生成する「OpenAPI Generator」オープンソースで公開。Swagger Codegenからのフォーク
REST API仕様からAPIクライアントやスタブサーバを自動生成する「OpenAPI Generator」オープンソースで公開。Swagger Codegenからのフォーク RESTful APIの仕様を基に、APIクライアント用SDK、APIクライアントのテスト用にAPIサーバのように振る舞ってくれるスタブサーバ、Webサーバのコンフィグレーション、ドキュメントなどを自動生成してくれる「OpenAPI Generator」がオープンソースとして公開されました。 RESTful API仕様の記述フォーマットは、2015年にマイクロソフトやGoogle、IBMらが立ち上げた「Open API Initiative」が提唱する「OpenAPI Specification」が事実上の業界標準となっており、OpenAPI GeneratorもこのOpenAPI Specificationを基に開
Web Authentication: An API for accessing Public Key Credentials - Level 2
This version: https://www.w3.org/TR/2021/REC-webauthn-2-20210408/ Latest published version: https://www.w3.org/TR/webauthn-2/ Editor's Draft: https://w3c.github.io/webauthn/ Previous Versions: https://www.w3.org/TR/2021/PR-webauthn-2-20210225/ https://www.w3.org/TR/2020/CR-webauthn-2-20201222/ https://www.w3.org/TR/2020/WD-webauthn-2-20201216/ https://www.w3.org/TR/2020/WD-webauthn-2-20201116/ htt
API 設計ガイド | Cloud APIs | Google Cloud
フィードバックを送信 API 設計ガイド コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。 変更履歴 はじめに これは、ネットワーク API の一般的な設計ガイドです。2014 年以来 Google 内部で使用され、Cloud API やその他の Google API を設計するときに Google が従うガイドです。この設計ガイドは、外部のデベロッパーへの情報提供と、互いの連携作業の効率化のためにここで共有されています。 Cloud Endpoints のデベロッパーには、このガイドは、gRPC API を設計するときに特に役立つことがあり、そのような場合にはこれらの設計原則を使用することを強くおすすめします。ただし、このガイドの使用は必須ではありません。Cloud Endpoints と gRPC はガイドに従わなくても使用できます。 このガイドは、gR
Swagger x Heroku で手軽に API モック＆ドキュメントを作る - Qiita
概要 Web、モバイル問わず、アプリケーション開発する際には、フロントエンドとバックエンド開発が一斉にスタートすることが多く、フロントエンド開発はバックエンド開発待ちになるケースがよくあります。この待ちの時に、フロントエンド側で仮で叩ける環境があると、実装をある程度進めることができ、開発が進みやすくなります。 この記事では Swagger と Heroku を用いて、 API のドキュメントとモック（スタブ）サーバーを手軽に作る方法を紹介します。 Swagger って？ Swagger は特定の書式で書くと API ドキュメントとかモックを良い感じで生成してくれるやつです。詳しい説明は公式ページをご参照ください。 手順 Swagger Editor で YAML 整形 モック＆ドキュメントのサーバーサイドコードを Generate する Heroku 用の修正をする Heroku にデプロ
通知 API の使用 - Web API | MDN
通知 API は、ウェブページやアプリからシステムレベルでページ外部に表示される通知を送ることを可能にします。これにより、アプリケーションがアイドルやバックグラウンドの状態であっても、アプリからユーザーに情報を送信することができます。この記事では、アプリで API を使用する方法の基本を見ていきます。 一般的にシステム通知とは、オペレーティングシステムの標準的な通知メカニズムを指します。一般的なデスクトップシステムやモバイル端末が、通知を行う方法の実例を思い出しましょう。 当然ながらシステム通知の仕組みはプラットフォームやブラウザーによって異なりますが問題はなく、通知 API はほとんどのシステム通知に対して十分な互換性を持つようになっています。 ウェブ通知の最も顕著な用途の一つが、ウェブベースのメールや IRC アプリケーションにおいて、新しいメッセージを受信したときに、ユーザーがほかの
Serverless FrameworkとExpressでお手軽にAPIサーバを作ろう - 迷ったらカレー
この記事は、Recruit Engineers Advent Calendar 20176日目の記事です。 こんにちは。最近マルチロールな働き方をしていて自分が何者なのかわからなくなってきた加藤です。現在リクルートジョブズというところでエンジニアをしています。 日頃、社内用のちょっとしたツールとか、試験的なAPIとかを作るのにAWS LambdaやDynamoDBを使ってサーバレスな開発をしているのですが、この記事ではその際によくやるServerless FrameworkとExpressを活用した開発手法の紹介をしたいと思います。 Expressといえば、Node.jsのWebアプリケーションフレームワークとして有名ですが、最近ではaws-serverless-expressというのを使うと、AWS LambdaでもExpressを使って開発ができます。サラッと書きましたが、正直こいつが
Swaggerで定義したAPI仕様から Retrofitで使用するinterfaceを自動生成してみる
- swagger-api/swagger-parser https://github.com/swagger-api/swagger-parser - square/kotlinpoet https://github.com/square/kotlinpoet - HOW TO CREATE A GRADLE PLUGIN IN KOTLIN https://www.thedroidsonroids.com/blog/how-to-create-gradle-plugin-in-kotlin - https://github.com/horie1024/gradle-generate-data-layer-plugin
Swagger+JSON SchemaでAPIの型をテストして開発サイクルをスピードアップさせた話 - pixiv inside
CTO兼福岡オフィス立ち上げ担当として新アプリを作っている@edvakfです。 JSON APIを開発しているとこういう問題がありがちですよね。 仕様どおりにAPIの形式を作ったはずだけどなんか自信が持てない テストでいくつかのキーが存在するかの簡単なチェックはしてるつもりだけど、全部チェックするのは大変すぎる APIのControllerやViewをリファクタリングしたらレスポンスの形が変わってアプリがめっちゃクラッシュし始めた というのが怖くて誰もリファクタリングできなくなった APIドキュメントがメンテされない 知らない間にレスポンスのフィールドが増えてたけどドキュメントに書いてない これらを解決したい！と思って試行錯誤したら、スマートに解決することができました。この記事ではRailsのことについて書きますが、考え方は他の言語・フレームワークでも同じです。 なお、今回使ったgemのバ
mailit - メール送信をWeb APIで
MOONGIFTはオープンソース・ソフトウェアを紹介するブログです。2021年07月16日で更新停止しました メールをシステムに組み込むのは意外と面倒で、SMTP用のライブラリをついつい頼ってしまいます。さらに日本語問題やHTMLメール、添付ファイルなど様々な用途があります。 それをシンプルに解決してくれそうなのがmailitです。メール送信をシンプルなREST APIで提供してくれます。 mailitの使い方 mailitは設定ファイルを用意し、そこに本来のSMTPサーバの情報を記述します。そしてmailitを起動するとWeb APIが立ち上がります。 使い方としては以下のようにコマンドを打ちます。そうするとSMTPサーバのレスポンスをJSONで返してくれます。 $ curl --data "to=admin@moongift.jp&subject=hi&text=hey world"
HTMLスクレイピングやファイルでのバッチ連携を不要に、「API管理ツール」でWebへRESTful APIを公開。ドキュメントもSwagger記述も自動生成［PR］
HTMLスクレイピングやファイルでのバッチ連携を不要に、「API管理ツール」でWebへRESTful APIを公開。ドキュメントもSwagger記述も自動生成［PR］ WebサイトやWebサービス上の情報を取得し加工したい、あるいは、別の情報と組み合わせるために情報を取得して再利用したい、というとき、そのWebサイトにデータを取得できるAPIが用意されていれば便利ですが、現在のところ、現実にそういうAPIが整備されているケースは滅多にありません。 そのため、WebサイトからHTMLを取得して解析することでデータを取得する、いわゆる「HTMLスクレイピング」を用いるケースも増えてきています。しかしIDとパスワードを第三者に渡してのスクレイピングは、Webサイトやサービス提供者として、セキュリティやサーバへの負担からも避けたいところでしょう。 社内の業務アプリケーションでも同様です。 自社のカ
GraphQLはWeb APIの次のフロンティアか？ | POSTD
RESTの規約。URLはリソースであり、CRUDはHTTP動詞にマップされる。 RESTの規約に1つ問題があるとすれば、規約が十分でないということでしょう。上記で”通常”、”多くの場合”、”時に”という表現を使ったのは、これらのやり方は仕様で推奨されているものの守られるとは限らないためです。実世界では、大抵のAPIはRESTishがせいぜいです。例えばStripeでは、リソース更新に PUT ではなく PATCH を使うべきですが、歴史的理由でそうはなっておらず、おそらく現時点では変更に値しないでしょう。いずれにしても開発者はドキュメントを読む必要があり、その時、 POST メソッドのユビキタスな使い方があることに気づくのです。 RESTには他の問題もあります。必要なものだけでなく全てが返ってくるため、リソースのペイロードが非常に大きくなることがあるのです。そして多くの場合、クライアントが
GitHub APIから学ぶ次世代のAPI実装方式GraphQL - Qiita
最近公開されたGitHubのAPIは、GraphQLという形式に対応しました。今後はこちらが主流になっていくようで、既存のREST APIからGraphQLへのマイグレーションガイドも提供されています。 今回は、このGraphQLについて、実際にGitHubのAPIを叩きながらその仕組みを解説していきたいと思います。 GraphQLとは 歴史 GraphQLは、Facebookの中で2012年ごろから使われ始めたそうです。その後2015年のReact.js Confで紹介されたところ話題となり、同年"technical preview"のステータスでオープンソースとして公開されました。その後仕様が詰められ、2016年9月に晴れて"preview"を脱し公式実装として公開されました。これと同じタイミングで、GitHubからGraphQLバージョンのAPIが公開されています。 このあたりの経緯
GraphQL APIをRailsアプリに実装した時のメモ | qnyp blog
今回は、qnyp GraphQL APIを設計・実装する過程で役立ったものや参考になった情報を実際のコードを交えて紹介しようと思います（qnypはアニメの感想を記録するサービスです）。API設計の詳細や具体的な実装手順までは踏み込みません。 API実装はRailsアプリ内で行っていますので、紹介するライブラリなどは主にRuby向けのものとなります。 GraphQLの概要をつかむ The Anatomy of a GraphQL Query このエントリは、GraphQLを使う際に知っておく必要のあるOperationやVariables、Fragments、Directiveといった概念を手っ取り早く俯瞰する際に役立ちました。 GraphQL APIの実装を進めていくと、最終的には graphql.org にある Introduction to GraphQL を隅々まで読むことになるとは
Insomnia - マルチプラットフォームで動作するWeb APIクライアント MOONGIFT
Web APIを使って開発を行っていると必要になるのがWeb API用のクライアントアプリになるでしょう。Web APIを細かな条件をつけて実行し、その結果を確認したり、JSONなどをフィルタリングできるのがポイントです。開発効率を向上させるのに必須の存在です。 そんなWeb API、今回はREST APIのクライアントソフトウェアがInsomniaになります。クラスプラットフォームで動くのがポイントです。 Insomniaの使い方 メイン画面です。 ヘッダー情報を確認できます。 Cookie。 タイムラインはより細かく確認できます。 OAuth2にも対応しています。 データフォーマットとしてはXML/JSON、フォームデータを送信できます。 InsomniaはElectronで作られているのでマルチプラットフォームで動作します。より直感的なインタフェースを目指しているとのことで、使いこな
APIマネジメントの世界で急速に成長する、Kongという存在
APIマネジメントの世界で急速に成長する、Kongという存在：共同創業者でCEOのMarietti氏に聞いた（1/2 ページ） 買収の続くAPIマネジメントの世界において、オープンソースかつ独立企業として注目を集めつつあるのがMashapeだ。2015年にオープンソース化した「Kong」は、200万以上ダウンロードされたという。CEOのAugusto Marietti氏に、同社の戦略を聞いた。 APIマネジメントの世界における新たなプレイヤーとして注目を集めつつあるのがMashapeだ。当初はAPIマーケットプレイスを運用していたが、その運用に使ってきた技術を「Kong」と名付け、2015年にオープンソース化。以来、200万以上のダウンロードがあったという。APIマネジメントの主要ベンダーが次々に買収された後では、オープンソースかつ独立企業というだけでも目立つ存在となっている。 2017年
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
まだAPI定義管理で消耗してるの？〜Swaggerを用いた大規模アプリ時代のAPI定義管理とコードジェネレート〜
失敗から学ぶAPI設計 #ccc_h4 #jjug #jjug_ccc JJUG CCC 2013 Spring
GraphQL対REST - 考慮すべき点
