レストラン事業部エンジニアの id:ninjinkun です。 一休レストランでは10年以上動いているシステムをPython 3で書かれた新システム（以下restaurant2）に順次移行する作業を進めています。現在ではPC用のレストランページ や主要な API を含め、いくつかのページがrestaurant2で提供されるようになっている状態です。本記事ではこの移行の経緯と、restaurant2システムの詳細、Pythonを選んだ理由、現在の進捗状況をお伝えします。 経緯 一休レストランはサービスローンチ時よりClassic ASP（言語はVBScript）でシステムが構築されてきました（こちらに驚かれる方も多いと思いますが、歴史的経緯という言葉で強引にまとめて話を先に進めます）。このシステムは現在も一休レストランを支えているのですが、長年の改修による複雑性の増加、言語の古さ、言語機能の
「The Twelve-Factor App」を15項目に見直した「Beyond the Twelve-Factor App」を読んだ - kakakakakku blog
2012年に Heroku のエンジニアによって提唱された「The Twelve-Factor App」は素晴らしく，アプリケーションをうまく開発し，うまく運用するための「ベストプラクティス」として知られている．2020年になった現在でもよく引用されていると思う．日本語訳もある． 12factor.net Beyond the Twelve-Factor App とは？ クラウド化が進むなど，提唱された2012年と比較すると技術的な変化もあり，今までの「The Twelve-Factor App」で宣言されていた観点以外にも必要な観点やベストプラクティスがあるのでは？という意見もある．そこで，2016年に Pivotal のエンジニアが「Beyond the Twelve-Factor App」を提唱した．The Twelve-Factor App にあった「12項目をアップデート」し，新
フロントエンドエンジニアの松原(@simezi9)です。BASEでは現在ショップ向けの管理画面をリニューアルするプロジェクトが進んでいて、UI/UXの更新と同時に創業当時から継ぎ足して作ってきたフロントエンドの技術スタックを一新しようとしています。この記事では、具体的にそのフロントエンドの更新でどのようなことに取り組んでいるのかをいくつかご紹介したいと思います。 Vue + TypeScriptを利用したMPA(multi page application)化 HTMLの構築をPHP(サーバーサイド)からJS(クライアントサイド)へ移行する 従来の「BASE」の画面ではPHPでHTMLの構築を行っていましたが、HTMLの構築をすべてPHPのコードから分離させて、Vueによるクライアントサイドでのレンダリングにしています。また管理画面の特性上（1ページあたりの閲覧時間が長く相対的にローディン
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を使って生成した 上記の方法だとリクエストパラメタとドキュメントの整合性を担保
Markdown で記述した API ドキュメントからお手軽にドキュメントサーバーとモックサーバーを生成する - Gulp で作る Web フロントエンド開発環境 #7 | PSYENCE:MEDIA
Markdown で記述した API ドキュメントからお手軽にドキュメントサーバーとモックサーバーを生成する - Gulp で作る Web フロントエンド開発環境 #7 wakamsha 2015.08.31 941 15687462236 2018年2月23日更新 : サンプルコードを ECMASCript 2015+ で書き直し、npm-scriptsでの例を加筆しました。 SPA 開発によるサーバーサイドとフロントエンドの完全分業化 Single Page Application ( 以下、SPA ) は従来のサーバーサイドレンダリングを基とした Web アプリケーションと異なり、iOS アプリや Android アプリと同じように Web API を通じてサーバーにリクエストを送り、JSON 形式などで返ってきたデータをもとにダイナミックにレンダリングすることで Web ページ全体
Sublime-Style-Column-Selection Atom で Sublime text のように矩形選択できるようになる。 Zen Zen モードになる。 人気だったから入れてみたけどあまり使わない。 api-blueprint-preview API Blueprint をエディタ内でプレビューする。 aglio が必要になる。 atom-alignment = の位置を揃えることができる。 atom-beautifier コードフォーマットをしてくれる。 atom-color-highlight エディタに入力した色名やカラーコードに従ってハイライトしてくれる。 autocomplete-plus オートコンプリート。 autocomplete-snippets オートコンプリートにスニペットも表示してくれる。 autocomplete-paths オートコンプリートにフ
API Blueprint. A powerful high-level API description language for web APIs. API Blueprint is simple and accessible to everybody involved in the API lifecycle. Its syntax is concise yet expressive. With API Blueprint you can quickly design and prototype APIs to be created or document and test already deployed mission-critical APIs. Tutorial Tools section Focused on Collaboration API Blueprint is bu
【API Blueprintの使い方】Web APIの仕様書を書く・読む・実行する | DevelopersIO
【API Blueprintの使い方】Web APIの仕様書を書く・読む・実行する できればドキュメント書きたくないなー。はやくAPI実装したい！俺の頭の中に全部仕様入ってるから！俺が仕様だ！ ... その仕様、API Blueprintでドキュメントにおこしませんか？ はじめに デバイスが多様化し、その違いを吸収する統一的なインターフェースが求められる昨今、Web APIはその回答のひとつといえます。弊社でも、モバイルアプリとWeb APIを組み合わせてサービスを構築することがあります。 Web APIが登場する開発では、モバイルアプリ（APIクライアント）メンバーと、APIサーバメンバーのコミュニケーションが不可欠です。開発を円滑に進めるために、APIの仕様書 が必要になります。お互いがAPIの仕様を想像して勝手に開発を進めたのでは、いざ結合したときに悲惨な結果になることが目に見えてい
OpenAPI Generator で API Client と型を自動生成した話 - BASEプロダクトチームブログ
フロントエンドエンジニアの @rry です。 自分は BASE の Sales Promotion というチームで主に新規機能開発を行っています。このチームでは主にオーナーさんの使う管理画面に新しく機能追加をしています。 そこで、管理画面で使っている API Client と型を、OpenAPI Generator を使って自動生成するようにしてみたのでそのお話を書きたいと思います。 そもそも OpenAPI とは？ https://www.openapis.org/ OpenAPI とは、RESTful Web サービスを記述、生成、使用、および視覚化するための仕様です。 ※ 以前は OpenAPI ではなく仕様自体も Swagger と呼ばれていましたが、現在は仕様自体については OpneAPI と呼ばれており、Swagger というのは OpenAPI を使ったツール群のことをさすよ
APIドキュメントを支える技術 - Qiita
最近のウェブ開発では各機能ごとをAPIでつなぎ込む時代になっています。 そのため、各チームが開発をしていく上で、 他のチームにAPIの仕様を伝える方法をきちんとまとめておく必要が出てきています。 そんな中でAPIドキュメントにどのような役割が求められていて どのような選択肢があるか、一旦自分の把握している知識をまとめています。 (ここで書いているAPIは、httpでアクセスしたら、JSON形式でレスポンスを返すウェブサービスのAPIを指しています) APIドキュメントを用意する上で、すぐにぶつかる壁 APIドキュメントを用意する場合に、何も考えずにExcelやwikiにまとめると、早い段階で メンテナンスのコスト の問題にぶつかります。 『APIドキュメントを書く時間がない』 『本当にドキュメント通りの結果が返ってくるか、試してみないとわからない』 『実際に返ってくるAPIとレスポンスが違
クライアント実装 サーバ実装 仕様 Web API にありがちなこと API ドキュメント リクエスト レスポンス ぶっちゃけAPI の追加時く らいしか更新していない なぜかドキュメントにない属性が 含まれている 手が滑ってドキュメントと若干違う形式の 属性を含めちゃったけどなんとなく通った クライアント実装 サーバ実装 仕様 いまは API Blueprint で頑張ってる (http://apiblueprint.org/) API ドキュメント リクエスト レスポンス Markdown の スーパーセット (ツラい) API Blueprint (YAML 表現) generate mock validate あんまり嬉しく ない なんか別に JSON Schema 書かない といけない クライアント実装 サーバ実装 仕様 今日話したいこと JSON Schema API ドキ
A full-featured HTTP Client Building great software is hard, and developer tools should be helping you without the headaches. RapidAPI for Mac is exclusively built for macOS, so you should easily get the hang of it. Every feature is built intuitively with quick mouse or keyboard shortcut access. Learn more about RapidAPI for Mac as an HTTP client Describe your APIs Visually build your API requests
k0kubun.hatenablog.com 非常に丁寧に書かれていると思うのですが、少し反論したい部分があるので、記載したいと思います。 GraphQLのキャッシュ効率について クエリをパースしないとキャッシュの可否を判定できないため、HTTPキャッシュが難しい こちらに関して、２つの観点から反論してみたいと思います。 まずに、GraphQL は GET リクエストでも送ることができます。Serving over HTTP | GraphQL によると、http://myapi/graphql?query={me{name}} のような URL の GET リクエストができます。(※そもそも、これ自体は GraphQL の絶対的な制約ではなく、 GraphQL を一般的に HTTP で提供するときのプラクティス、という位置づけです) そして、GraphQL は 1 回のリクエストで送らな
概要 Vue.js+TypeScriptで開発する際によく参考にしている記事をまとめています。 自分用なので、自分記事が若干多めです。随時更新 この記事良かったよーとか、教えていただけると助かります。 環境構築 Vue CLIのプロジェクト管理UIがいい感じだった https://qiita.com/kai_kou/items/8fcabc7a8445c1be8a30 DockerでVue.js+TypeScript開発環境を構築する https://qiita.com/kai_kou/items/d581a9f8f3ee8605aed1 Vue.js + SCSS + Bootstrap + MaterialDesign + TypeScript開発環境をつくってみた https://qiita.com/kai_kou/items/a404c73c8bb23f25c510 Vuexによる
API(とそれに携わる開発者)の規模が拡大してくると、ドキュメントの整備や、仕様と実装の一貫性の維持、 クライアントとの知識の共有など、考慮すべき問題が沢山出てくる。 これらの問題に対する現実的な解決策を探るため、 ApiaryというAPI開発支援用のサービスを簡単に俯瞰することにした。 ここでは紹介しないが、他に RAML、 JSON Schema、 Swagger、 WADL、 Autodoc などが関連するものとして挙げられる。 Apiary http://apiary.io/ Apiaryは、API Blueprintと呼ばれる言語でAPIのインターフェース仕様書を記述する、という開発方法を提唱している。 API BlueprintはMarkdownを拡張した言語で、特殊な記述を用いて幾つかのメタ情報を付与出来る形になっている。 Markdownを採用することで人間にとって読み書き
Go で始める JSON-RPC 入門
Gopher artwork is taken from gophericons. Created by Olga Shalakhina, based on original work by Renée French. Licensed under Creative Commons 3.0 Attributions.この記事は、 Go Advent Calendar 2016 の 15 日目の記事です。 みなさんは、JSON-RPC を使ったことがありますか？ この記事では、 Go で JSON-RPC を使用する方法をレクチャーしたいと思います。（※ この記事は、 golang.tokyo #2 での LT 内容をベースに加筆修正を加えたものになります。） JSON-RPC とは概要JSON-RPC は、 JSON を媒体とした Remote Procedure Call です。 そのた
自分の使っているツールが会社のメンバーに意外と知られていなかったので、紹介してみたら好評だった。そこでこちらでも紹介してみることにした。 Alfred https://www.alfredapp.com/ マカーな開発者にはお馴染みのイケてるランチャー むしろ使っていない人を知りたい さらにはかどるWorkflowの使えるPowerpackは£19～ Stay https://cordlessdog.com/stay/ ウィンドウ位置記憶ツール（有料） アプリ毎やウィンドウ毎に、位置とサイズを覚えてくれる デュアルディスプレイ時と通常時で別々に記憶してくれる！ ノートPCでデュアルディスプレイするなら必須かも 公式サイトかApp Storeから約$18で買える HyperSwitch https://bahoom.com/hyperswitch ウィンドウ切り替えツール Cmd+Tabのす
Swaggerの概要をまとめてみた。 - Qiita
最近は API Blueprint で仕様書を書くことが多かったのですが、Swagger が世界標準になるかもしれない、ということもあり、開発の効率化を進めるためにも概要をまとめてみようと思った次第です。 Swaggerとは Swagger は RESTful APIを構築するためのオープンソースのフレームワークのことです。「Open API Initiative」という団体がRESTful APIのインターフェイスの記述をするための標準フォーマットを推進していて、その標準フォーマットがSwaggerです。Swaggerには多くの便利なツールが提供されていることもあり、多くのメリットを享受できそうです。 Swagger Spec を書いておけば自動的にドキュメント生成までしてくれ、それだけではなく、ドキュメントから実際のリクエストを投げられる優れものです。 Swaggerのツール群 ツール
この記事はGoCon 2016 springで話す内容を圧縮するためのものです。 WebサービスのAPI仕様を記述したりするためのそれなりに有名な仕様について、筆者(@vvakame)の私見を述べていく。 なお、Google Trendの結果を見ると…。 仕様を調べてSwaggerを選択する事にしたのは1年弱程度前のはずなので、もし "今はそれもうできるよ！" とかあったらコメントなどで教えてください。 RAML RESTful API Modeling Language なので、手書きを前提にしている。 YAMLで頑張って仕様を書く。 Spec APIs Explorerっぽいものもあるっぽい。 総評 比較的広く使われているようでパワを感じる。 まず仕様が先というスタイルなのがめんどくさそう。 YAMLなのがちょっとイヤ。 RAMLからGoとJavaScript(TypeScript)向
成果物：apiary.ioによる、APIドキュメント とりあえず見て貰えるとイメージつかみやすいです↑ あらすじ 100万円欲しいのでAPIを利用したアプリ開発を学ぶ絶好の機会なので、東京メトロオープンデータ活用コンテストに挑戦しようとしている。 前回、とりあえずざっと触ってみてAPIのイメージは掴んだ 今回は、公式ドキュメントと実際のレスポンスを咀嚼して、仕様設計を汎用ドキュメント化しつつ理解していくことを目的とする せっかくドキュメント化するからには、汎用性と実用性が高いフォーマットとしたい（オレオレにはしたくない） 成果物 API Blueprintで記述されたテキストをApiary.ioでホスティングし、以下を作った TokyoMetroOpendataAPI · Apiary github上のソース（markdownプレビュー版） やってみてわかった、ApiaryによるAPIドキ
一昨年からだいたい月1回ぐらいのペースで、Webの基本的な仕組みを基礎から学ぶ「RESTful#とは勉強会」を開催しています。主催はshokolaさんで、私は進行役を担当しています。 2月23日に開催したRESTful#とは勉強会13では、ヴァル研究所さんの協力のもと、駅すぱあとWebサービスをレビューするという企画をやりました。いろんな意見が出てとてもおもしろかったです。みなさんありがとうございました。 RESTful#とは勉強会13 当日の内容とポイント RESTful#とは勉強会13 ツイートまとめ ゲストとして来ていただいた@Keisuke69さんがブログ記事を書いておられたので、これは私も書かなければ、ということで感じたことを書いていきます。 keisuke69.hatenablog.jp 駅すぱあとWebサービスについて、当日思っていて言い忘れたこと トークンをURLのクエリパ
WebRTCを用いた生放送iOSアプリを開発した話 Part1 新規アプリ開発の進め方 | Nagisaのすゝめ
はじめに こんにちは、インキュベーション事業部所属 iOSエンジニアの葛山です。 タイトル通り、WebRTCを用いた生放送iOSアプリを開発し本日リリースしましたので、使った技術や苦労した箇所などをプロジェクト振り返り的な感じでまとめられればと思います。 WebRTCを触ってみた的な紹介記事は多いと思うのですがiOSアプリでがっつり採用した事例は少ないと思うのでそちらも踏み込んで書ければなと。 先日リリースした101 LIVEです! また、これからiOSアプリを新規開発しようとする人たちにとっても参考になる記事になれば良いなと思います。 WebRTCとは？ WebRTCはWeb RealTime Communicationの略で、ブラウザが直接通信し、映像・音声といったデータをリアルタイムにやりとりすることを可能にした技術です。 通信の特徴としてP2P方式でユーザー間で直接通信を行うためレ
OpenAPI Specification ドリブンな開発事例とそれを支えるツール - NTT Communications Engineers' Blog
これは NTT Communications Advent Calendar 2021 3日目の記事です。 こんにちは、イノベーションセンターの松田 (@take4mats) です。 当社の Smart Data Platform (SDPF) のサービスラインナップの多くは、お客さまがサービスご利用に必要な操作を統一的に行うための Web UI に加え、同等の Web API を提供しています。 API 仕様は Knowledge Center にてサービスごとに一般公開されているのをご存知でしょうか？ (Knowledge Center で各サービス内の APIリファレンス のページをご覧ください。例えば こちらのリンク) この一般公開されている API 仕様はサービス開発初期に作成され、開発期間にも重要な役割を果たしています。 本記事では、その中で私が携わったサービスから、 API
Cloud Functions をローカル環境で統合テスト可能にした話 | BLOG - DeNA Engineering
はじめまして。AIシステム部MLエンジニアリンググループ で学生インターンをしている 早坂( @takemioIO ) です。 普段はパケット処理などをやっているのですが、縁あってここでは MLOps の通常業務に携わっております。 私は二ヶ月間インターンとして開発に取り組んでいました。ここではその実装物の一つを紹介します。 この AI システム部 のとあるプロジェクトでは、 Cloud Functions と Cloud Pub/Sub を利用したデータパイプライン を構築しております。 そのプロジェクトは毎日のように変更が取り込まれ、非常に開発が盛んですが一方それゆえに破壊的な変更で足を撃ち抜いてしまいそれによって悩まされることがありました。 さらにはクラウドサービスを利用してるという部分からローカルでの検証環境がありませんでしたので、毎回 GCP に デプロイするしかなく、トライアン
RubyKaigi 2017 でどんな発表をしたか 発表スライド 荷物とともに PC 送っちゃったのであとで貼ります ほぼ同内容のテキストはこちらの 4 記事です。 RESTful API のおさらい Rails での JSON API 実装まとめ スキーマファースト開発 The NEXT of REST 発表時の twitter での反応 togetter にまとめておきました。 API Development in 2017 - RubyKaigi 2017 #rubykaigi - Togetterまとめ Proposal 事前資料の公開が推奨されていたので、CFP に出した内容も置いておきます。 事後になってしまい申し訳ありません。 Title API Development in 2017 公開されてから思ったんだけど、RubyKaigi は ruby の API の話が多いので
Sublime-Style-Column-Selection Atom で Sublime text のように矩形選択できるようになる。 Zen Zen モードになる。 人気だったから入れてみたけどあまり使わない。 api-blueprint-preview API Blueprint をエディタ内でプレビューする。 aglio が必要になる。 atom-alignment = の位置を揃えることができる。 atom-beautifier コードフォーマットをしてくれる。 atom-color-highlight エディタに入力した色名やカラーコードに従ってハイライトしてくれる。 autocomplete-plus オートコンプリート。 autocomplete-snippets オートコンプリートにスニペットも表示してくれる。 autocomplete-paths オートコンプリートにフ
最近APIのバリデーションを行うのにJSON Schemaを使おうという話をよく聞くのですが じゃあやってみようとすると、単体のJSONのバリデーションを行うことは出来るけれど それが実際の運用に適用できるようにするためには、 それなりに考えなくてはいけないようです。 JSON Schemaって? JSON Schemaは、文字の通りJSONのスキーマ定義を明確にするものです。 2014/09/07現在、IETFにdraft v4が3つに分割されて公開されています。 JSON Schema Core JSON Schema Validation JSON Hyper-Schema それで、単体のJSONファイルの確認ならばCoreだけで十分なのですが WebサービスのAPIを管理しようとなると、 JSON Hyper-Schemaのほうで定義されているlinksを使って、ひとつのURIに対
こんにちは Mirrativ CTOの夏です。 現在、ミラティブでは事業部単位でチームや目標を管理しており、エンジニアが所属するチームとして以下の6つがあります。今回はこのうち、エンジニアチームについて、2019年度に行ってきた取り組みの振り返りをしたいと思います。 ライブプラットフォームチーム ユーザの定着を追う マーケ連携チーム ユーザの新規獲得を追う エモモチーム 3Dアバターであるエモモを使った新体験の創出・基礎体験の向上を追う ストリーミング改善チーム モバイル端末でのライブストリーミングの配信・視聴の品質改善を追う インフラチーム クラウド上での安定したインフラ基盤の設計・構築を追う エンジニアチーム お問い合わせ調査、不具合・障害の再発防止、開発体験の向上を追う AI技術部 コミュニティやストリーミングとAI活用の可能性を追う 毎週定例で振り返りを行っており、Confluen
スキーマファースト開発のススメ - onk.ninja
第 2 部 で 現在 5 派閥ぐらいありそうです。 と書いた中でなぜ OpenAPI を選んだのかというと、 JSON Hyper-Schema は Hypermedia の技術なので、1 サーバ 1 クライアント、同一チームで両方を見るという private API では出番が無い。 RAML はコミュニティ規模が OpenAPI, API Blueprint に比べて小さかった OpenAPI と API Blueprint、生 JSON Schema だと、OpenAPI が一番「RESTful API」に特化していて、かつ詳細度が高い といった辺りです。 OpenAPI は ruby だとライブラリが (当時は) 少なかったのですが、まぁ作れば何とかなるだろうと採用しました。 最近のトレンドでも Swagger 1 強になってるっぽくて、良い選択をしたなぁと思っています。 Open
Golang + echoなREST APIサーバで、テスト実行時に自動でAPIドキュメントを生成できるようにする - 一から勉強させてください
最近、Golang (+echo) で REST API サーバを開発する機会があったのですが、テストを書いたら API ドキュメントを自動生成するような仕組みを作るために試行錯誤したのでメモです。 方針 API ドキュメントの生成にはtest2docを利用 テストを実行すると API Blueprint 形式でファイルを自動生成してくれそう 該当するメソッドの上にコメントを書くことで最低限の説明は記述できそう README には gorilla/muxと julienschmidt/httprouterのサンプルしか載っておらず echoでうまく動くかは試してみるしかなさそう テストから生成された .apibファイルをaglioみたいなツールにかませば HTML ファイルとして API ドキュメントができそう プロジェクト構成 github.com/danimal141/rest-api
Rails での JSON API 実装まとめ 前後リンク RESTful API のおさらい Rails での JSON API 実装まとめ スキーマファースト開発 The NEXT of REST Ruby on JSON の図のような流れになるんですが、それぞれ見ていきます。 to_json (2011-2013 頃) 2011-2013 年頃、僕らは render :json を使っていました。 render json: @user render json: @user.to_json として User#as_json や User#to_json を利用します。 この頃はまだ SPA という言葉もなく、ネイティブアプリもそこまで流行っていなかったので これで十分だったのですが、どんどん API に世の中が寄っていき、限界を迎えます。 この頃のツラみ JSON を組み立てるのが大変
【登壇資料】エンジニアのチーム開発入門 – 心技体を磨いて自身とチームをより良くしよう #cm_osaka | DevelopersIO
2017年4月14日（金）、クラスメソッド株式会社 大阪オフィス にて モバイルアプリのチーム開発実践入門 in 大阪が開催されました。 スピーカーとして参加しましたので、レポートします。 勉強会は大阪にて全7回開催予定です。概要については以下を参照してください。 【 大阪オフィス開設1周年!! 】クラスメソッドの開発を知る！全7回勉強会開催 いち エンジニア がチーム開発を行うには？ ここ最近はコラボレーションツールが充実し、チーム開発の参入障壁は大幅に下がったと思います。そこからさらに、DevOps、スクラム、レビュー技法、ペアプログラミング等、様々な粒度で、チーム開発をより効率的に、より精度高く行う方法論や考え方がどんどん出てきています。 とはいうものの、やはりチームというのは「個」の集まりです。今回の発表は「とあるエンジニアがチーム開発に参加する」という視点です。チーム力は、「力を
TypeScriptの型定義からJSON Schemaを生成するオンラインツールを作ってみた - Qiita
先日、TypeScript + Tynderから始める宣言的検証生活の記事にて スキーマ検証ライブラリTynderを紹介いたしました。 Tynderとは Tynderは、TypeScriptのサブセット＋独自の拡張文法から成るDSLによって 型の検査 単独の項目の必須・値の長さ・範囲や文字列パターンの検証 複数項目の相関や整合性検証の一部 (Union typeによる) を宣言的に行うことができます。 今回はTynderのスキーマ変換機能を使用して JSON Schema、GraphQL、Protobuf3 のスキーマを生成するオンラインツールを公開しました。 (GraphQL、Protobuf3については実験的機能です) TypeScript (Tynder DSL) → JSON Schema | GraphQL | Protobuf Converter Convert schema
Goでの小さいweb開発について 依頼されて開発をして、3年近く小さめのwebサイトをGo + Revelで運用してきて正直そこまで恩恵を受けれなかったように感じる。ので以下のように構成変更した。 Before 言語: Go v1.9 パッケージ管理: dep フレームワーク: Revel v0.21.0 ORM: GORM ミドルウェア: なし、cacheはrevel cache DB: MYSQL 開発環境: Docker CI/CD: CircleCI こうなるまでにも3年間でいろいろしたんですが、いろいろ問題がありました。 Beforeの問題点 Revelが思ったほど盛り上がらなかった GoでのフルスタックなMVCフレームワークとして前は盛り上がってたけど・・・ Web開発のためのモジュール追加があまりなかったので自前で実装した部分がとても多かった Goの変遷がめんどかった Goを
APIドキュメントを生成するためのMarkdown拡張API BluePrintとその周辺のライブラリ - Qiita
API Blueprint(以下Blueprint) は MarkdownファイルからAPIドキュメントやサンプルデータになる JSONを生成する仕様。 一旦決められたフォーマットのJSONに吐き出すので、 それを中心に入出力のライブラリが色々あったりする。 Blueprintのパーサー MarkdownからJSONを出力するために Snow Crashというライブラリを利用する。 後に書くものは大体このSow Crashを利用するので詳細は省略。 BlueprintからAPIドキュメントHTMLを生成する Blueprintを上手く扱うために、 色々なライブラリが用意されている。 aglioはBlueprintから表示用htmlを用意してくれるライブラリ。 # output.htmlにファイル出力 $ aglio -i input.md -o output.html # デフォルトの h
チームのWeb API開発を最適化するSchema Driven Developmentの解説＆実装例 - Qiita
チームでのWeb API開発において、進行を妨げる要因は様々な形で噴出します。 「フロントはバックエンドのAPI実装待ちなので動けません...」「ドキュメンテーションのコストが重い...」「ドキュメントと実装が全然違うので参考にならない...」 また、APIスキーマ設定が不十分だと、ビジネスドメインの最低原則やクライアント側のニーズを理解せずに、バックエンド都合のAPIがそのまま実装される危険性もあります。 そうした問題を解決すべくSchema Driven Developmentと呼ばれる開発手法が生まれました。 Schema Driven Developmentとは？ Schema Driven Development(以下SDD)とはチームにおけるWeb API開発フローを改善する開発手法の一つです。スキーマ駆動開発やSchema First Developmentとも呼ばれています
GitHub - danielgtaylor/aglio: An API Blueprint renderer with theme support that outputs static HTML
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert
2019/03/18 この記事は書かれてから1年以上が経過しており、最新の情報とは異なる可能性があります techAPIOpenAPI 現時点での OpenAPI に関する知識の棚卸しをした方がいいかなと思ったので書きます。 前提使い方が 100% 定まっているわけではありません少なくとも OpenAPI を使っていくこと自体は間違ってないという考えで使っていますGraphQL については触れませんOpenAPI とは何か？ 端的に言うと、 RESTful API に関するインターフェース定義 です。 一方で、そのインターフェース定義は YAML ファイルもしくは JSON ファイルで表されるため、 単なる YAML (JSON) ファイル だということもできると思います。 その仕様に沿って書くことで、周辺ツールであれこれ便利なことができます。 こんな便利なことができる定義ファイルを元にド
おはこんばんちは!! 尾藤 a.k.a. BTO です。 Web APIの仕様の定義ってみなさんどうされているでしょうか。 人によって書き方がバラバラだったり、定義に過不足があったりしてないでしょうか。 Web APIのインターフェースで定義する内容は、ほとんど決まってます。 もっと形式的な書き方できないだろうかと探してみたら、やはり同じ事を考えている人がいて、API Blueprintというのを見つけました。 API Blueprint - API Documentation with powerful tooling API Blueprintを使うとMarkdownでAPIの定義ができます。 できること APIの記述フォーマットが決まっていますので、どこで何が定義されているかが分かります。 ですので、機械的に処理する事ができるようになります。 具体的には、 APIドキュメントの生成
概要 Vue.jsでVuex+axiosを利用してみました。 コードをシンプルにすると理解が進んで良いです^^ GitHubにコードをUPしましたので、よろしければご参考ください。 https://github.com/kai-kou/vue-js-typescript-vuex-axios 環境構築 Dockerを利用して、APIのモックサービスも立ち上げられるようにdrakovを利用しています。 drakovについては下記をご参考ください。 api blueprintとdrakovを利用してAPIモックサーバを立ち上げる https://qiita.com/kai_kou/items/bdbb6c3f8d1ac655595d
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
一休レストランPython移行の進捗 - 一休.com Developers Blog
次世代の管理画面を作るフロントエンドの取り組み - BASEプロダクトチームブログ
僕が考えた最強のAPIドキュメント生成 - 銀の人のメモ帳
Atom でインストールしている package 一覧 - Qiita
API Blueprint | API Blueprint
JSON Schema で Web API のスキマを埋めよう
RapidAPI for Mac – The most advanced API tool for Mac
「GraphQLは何に向いているか」に対してのちょっとした反論 - 病みつきエンジニアブログ
Vue.js+TypeScriptで開発するときの参考記事まとめ - Qiita
Apiary - r7kamura per second
Mac使い向けのはかどるGUIツール10選 - Qiita
GoConの前哨戦として各種API仕様記述フォーマットについて概要を述べておく - Qiita
「東京メトロオープンデータ活用コンテスト」②APIの仕様設計を理解し、ドキュメント化する - Qiita
RESTful#とは勉強会13 を開催しました #RESTudy - tkawaのはてぶろ。
RubyKaigi 2017 でどんな発表をしたか - onk.ninja
Atom でインストールしている package 一覧 - Qiita
JSON Schemaを上手く運用出来そうなprmdとその周りのお話 - Qiita
ミラティブ エンジニアチーム四季報（創刊号） - Mirrativ Tech Blog
Rails での JSON API 実装まとめ - onk.ninja
GO + Revelで開発していたものをLaravel + nuxtで置き換える - Qiita
OpenAPI (Swagger) の基本的なあれこれ
APIの仕様をMarkdownで定義する - HDE BLOG
Vue.jsでVuex+axiosを利用してAPIを叩く - Qiita