企業ページリプレイス ~OpenAPIの活用~ | PR TIMES 開発者ブログ
こんにちは、21新卒エンジニアの柳です。 先日、PR TIMESの企業ページをSmartyというテンプレートエンジンからReactへリプレイスを行いました。その際にOpenAPIを社内のプロジェクトで初めて導入したので、OpenAPIのメリットや活用方法について書きたいと思います。 プロジェクトの背景 OpenAPIの説明に行く前に、企業ページをReactへリプレイスするに至った背景について少しお話しします。 企業ページをReactへリプレイスを行うことになった背景は以下の2点です。 現状使用されている JavaScript, jQuery では今後の機能追加に応えることが困難PR TIMES全体のフロントエンドのレガシー改善プロジェクトの最初の一歩として 企業ページは企業の様々な情報を1つにまとめたページになっているためデータ量も多く、また非同期通信によるLoad Moreやアニメーショ
API仕様を書く（まとめ）: 柴田 芳樹 (Yoshiki Shibata)
「API仕様を書く」として私自身の過去の経験を書いたものを読みやすく並べてみました。 API仕様を書く（1） API仕様を書く（2） API仕様を書く（3） API仕様を書く（4） API仕様を書く（5）ー gRPC protoファイル ー API仕様を書く（6）ー gRPC protoファイル（2） ー API仕様を書く（7） ちょうど同じような内容が『A Philosophy of Software Design』に書かれていました。 関連する章は、第12章「Why Write Comments? The Four Execuses」と第15章「Write The Comments First」です。第12章では、コメントを書かない理由として多くのソフトウェアエンジニアが挙げる理由について反証しています。第15章ではコメントを最初に書くことの有用性を説いています。ここでのコメントは、私
Swagger x Heroku で手軽に API モック＆ドキュメントを作る - Qiita
概要 Web、モバイル問わず、アプリケーション開発する際には、フロントエンドとバックエンド開発が一斉にスタートすることが多く、フロントエンド開発はバックエンド開発待ちになるケースがよくあります。この待ちの時に、フロントエンド側で仮で叩ける環境があると、実装をある程度進めることができ、開発が進みやすくなります。 この記事では Swagger と Heroku を用いて、 API のドキュメントとモック（スタブ）サーバーを手軽に作る方法を紹介します。 Swagger って？ Swagger は特定の書式で書くと API ドキュメントとかモックを良い感じで生成してくれるやつです。詳しい説明は公式ページをご参照ください。 手順 Swagger Editor で YAML 整形 モック＆ドキュメントのサーバーサイドコードを Generate する Heroku 用の修正をする Heroku にデプロ
開発者向けSaaS「Rocro」：自動でコードをレビュー、API文書を生成
印刷する メールで送る テキスト HTML 電子書籍 PDF ダウンロード テキスト 電子書籍 PDF クリップした記事をMyページから読むことができます ソニーネットワークコミュニケーションズは9月14日、新会社Rocro株式会社を設立し、ソフトウェア開発者向けサービス群「Rocro」（ロクロ）のパブリックベータ版の提供を開始した。 同サービス群は、GitHub.comやBitbucket.orgのレポジトリと連携し、自動でコードレビューやAPIドキュメント生成、負荷試験を行うソフトウェア開発者向けSaaS。サービスの利用はウェブサイトから申し込むことができ、ベータ期間中は無料で利用できる。 Rocroは「Inspecode（インスペコード）」「Docstand（ドックスタンド）」「Loadroid（ロードロイド）」の3つのサービスの総称。4月から日本、アメリカ、インドの60社以上の組織
Cat as a service (CATAAS)
Is a REST API to spread peace and love (or not) thanks to cats. Have 0 cats for now Give me a cat Hey cat lovers, new major version of cataas : Now JSON will returns if request contain application/json header, API doc updated hereFix tags search and fix tags combined with "," separator (see documentation)
開発効率を上げるWebAPIドキュメントの書き方 - Qiita
個人的にAPIサーバーを書くことが多く、APIクライアントの担当エンジニアと作業をする上で、効率よく作業できるAPIドキュメントの書き方を探していました。 今のところAPI Blueprintというフォーマットがしっくり来ていて、実際に私達が運用しているやり方と合わせて紹介したいと思います。 やりたいこと 当初APIのドキュメントに困っていたこと、やりたかったことは以下の通りです。 場所と時間に制約されず、API設計を非同期でレビューしたい バージョン管理したい 簡潔に書きたい リッチテキストは嫌だ！ API Blueprintとは ざっくりいうと、MarkdownでAPIドキュメントを書くためのフォーマットのことです。 また、オープンソースの周辺ツールが非常に強力で、API Blueprintで書かれているドキュメントを読み込んでAPIのモックサーバーを建てるものや、テストケースを作成す
こんなに使える！今どきのAPIドキュメンテーションツール
Dapr × Kubernetes ではじめるポータブルなマイクロサービス（CloudNative Days Tokyo 2020講演資料）NTT DATA Technology & Innovation
物理サーバを選定する際のポイント – Eureka Engineering – Medium
Eureka EngineeringLearn about Eureka’s engineering efforts, product developments and more.
システムプログラミング会 - 兼雑記
すごい久々にイベントの(共同)主催的なことをしました http://connpass.com/event/34995/ イメージとしては言語雑談会的な感じで、closedに人集めてウダウダやるつもりだったんですが、途中でPFNさんに場所貸していただけるということで、不特定な人を呼ぶことになって、当初想定してたより大袈裟な会になりました。適当に募集すると人が集まって自己顕示欲が満たされるとか、普段得られない種類のフィードバックが得られたり交流ができる、てのがあるわけですが、めんどくさいのとグダグダ雑談がしにくいのが難点ですね。まあ自分自身が一般的に募集されてる会で勉強した面もあるわけで、そういうのの恩返しになるかもという面もあり、まあ色々。 まとめとしてはkoieさんのブログやtogetterがまとまってそう http://blog.livedoor.jp/hkoie/archives/55
面倒な手続き不要！「Web API」の超お手軽活用術をJavaScriptコード付きで一挙大公開！ - paiza times
どうも、まさとらん（@0310lan）です。 今回は、面倒な登録手続きやトークンなどが一切不要で、今すぐ利用できる便利な「Web API」を厳選してご紹介しようと思います。 これらのAPIを使うことで、Web制作がちょっと便利になったり、独自性のあるユニークなサービスを構築できるようになるでしょう。 また、簡単に扱えることから、「Web APIを使って何か作ってみたい…」と思っている初心者の方にもオススメですよ！ ■「Web API」の使い方！ 今回ご紹介する「API」は、いずれも「JSONP」形式でデータが取得できるので、普通のJavaScriptだけで試すことが出来ます。 以下のコードを、HTMLファイルに記述するか、新規にJSファイルを作って読み込むようにしましょう。 var script = document.createElement('script'); script.src
web audio lesson
web audio lesson lessons lesson 01 lesson 02 lesson 03 lesson 04 lesson 05 lesson 06 quizzes lesson 01 / answer lesson 02 / answer lesson 03 / answer lesson 04 / answer lesson 05 / answer
[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を使って生成した 上記の方法だとリクエストパラメタとドキュメントの整合性を担保
APIドキュメントブラウザDash用日本語版Docsetsまとめ
超速ドキュメントブラウザを日本語で 「Dash」は、多種多様なプログラミング言語やライブラリ、ツールのリファレンスを素早く引けるドキュメントブラウザ。 OS Xユーザでプログラミングをする人は、名前を聞いたことがあるはずです。 ドキュメントはDocsetsという形で150以上登録されており、ワンクリックでインストール可能。すぐに検索・参照できるようになります。本当に便利！ 便利というレベルを超越して、必需品のレベル。 OS X版とiOS版があります。 OS X版 Dash 3 – API Docs & Snippets. Integrates with Xcode, Alfred, TextWrangler and many more. カテゴリ: Developer Tools 販売元: Bogdan Popescu（サイズ: 11.8 MB） 全てのバージョンの評価: （19 件の評価
API Design: A Documentation-first Approach - DZone
What exactly makes a “good” API? That is a question a lot of developers ask when designing their first API. While there are hundreds of resources online, all with differing opinions about what defines “good,” the majority of them share some similar themes. Logical endpoint naming conventions, clear error messaging, accessibility, and predictability are all crucial pieces in any well-designed API.
REST APIドキュメント作成ツールはapiary.ioが決定版かもしれない - Qiita
背景 APIドキュメントを書くのが楽になるツールまとめ - Qiita iodocsで便利なREST APIドキュメントを作成する - Qiita これまでずっとREST APIドキュメントをwiki上で管理していて、重たいページ上で特殊記法使ったり、スタイルの調整に時間を取られるのが辛かった。そこで良さげなドキュメントツールを色々調べてたんだけど、最終的にapiary.ioが一番良さそうという結論になってきた。 このサービスの主な特徴。 markdown記法でAPIドキュメントを記述できる ドキュメントの生成と同時にAPIのモックサーバを用意してくれる サインアップから5分くらいあればドキュメント公開できる。ドキュメントのホスト先を気にしなくてもいい。 特にドキュメントと一緒にモックを作ってくれるのは他にはないポイントでかなり便利。 使ってみる サインアップはGithubアカウントで h
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 ·
Autodoc - r7kamura blog
闇Advent Calendar 1日目の記事として、最近の開発における心の闇に触れます。 最近開発した Autodoc というツールについて簡単に説明した後、 この手のツールの開発にあたって考えていた、 創作活動の在り方や、社会の斥力、25歳定年説などについて触れようと思います。 Autodocとは Rack applicationで実装されたAPIに対して、RSpecで書かれたテストを元にAPIドキュメントを生成するもの。 テストを実行すると、テスト中に発行したリクエストやレスポンス、そのテストに付けられたメッセージを元に、 良い感じに情報をまとめ、Markdown形式でAPIドキュメントを記したファイルを生成してくれる。 例えばGitHubではMarkdownファイルを適当に描画してくれるので、 下図のようにGitHub上で簡単にドキュメントを閲覧出来るようになる。 テストの書き方
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Testing an API Against its Documentation