25000行超えのAPIドキュメントを分割した話

2024/03/22 54 users OpenApi 知見 スキーマ駆動開発 伊藤 弊社

はじめに COUNTERWORKSバックエンドエンジニアの伊藤です。 この記事ではAPIドキュメント分割の知見を紹介します。 弊社では OpenAPI を使用したスキーマ駆動開発を採用しています。 1ファイルで管理していたところ、25000行を超える行数となり管理コストが高くなっていました。 そこで分割作業を実施したのですが、どの... 続きを読む

Qiita API v2のJSON Schemaを公開しました - Qiita Blog

2015/06/05 138 users JSON Schema Qiita Qiita API イカ

こんにちは、r7kamura です。 最近は主にイカとして活動しており、カラフルな墨を掛け合う日々を送っています。 さて、QiitaおよびQiita:Teamでは、Qiita API v2としてデータを操作するためのREST APIを公開しています。これまで開発者向けに APIドキュメント を提供していましたが、今回は主に機械向けのインターフェースとして、JSON Schemaで記述したREST ... 続きを読む

REST APIドキュメント作成ツールはapiary.ioが決定版かもしれない - Qiita

2014/06/04 305 users Qiita REST ドキュメントツール 背景 WIKI上

背景 APIドキュメントを書くのが楽になるツールまとめ - Qiita iodocsで便利なREST APIドキュメントを作成する - Qiita これまでずっとREST APIドキュメントをwiki上で管理していて、重たいページ上で特殊記法使ったり、スタイルの調整に時間を取られるのが辛かった。そこで良さげなドキュメントツールを色々調べてたんだけど、最終的にapiary.ioが一番良さそうという結... 続きを読む

JSDoc Toolkit→JSDoc 3移行ガイド - Technology of DeNA

2013/05/08 61 users JSDoc フランシスコ 渋川 DeNAさん ウェブサイト

JSDoc Toolkit→JSDoc 3移行ガイド by 渋川よしき 2013/05/08 10:59 on JavaScript ツイート こんにちわ、DeNAサン・フランシスコの渋川と申します。エンジニアブログには初登場です。 JavaScriptのソースコードからAPIドキュメントを生成するツールには何種類かありますが、本語の書籍やウェブサイトでも情報が得られることもあって、JSDocの系... 続きを読む

各種サービスのAPI情報をまとめた『API for that』 | 100SHIKI

2013/05/03 559 users 100SHIKI tumblr GitHub API情報 自分

お、これは便利そう。 API for thatでは、各種サービスのAPI情報をまとめているようだ。 Dropbox、Tumblr、Github、などなどとの連携サービスを作るときに良いだろう。 もちろん自分で調べることもできるが、APIドキュメントはサイトの奥の方にあってうまく検索できないこともあるのでこうしてまとめられているとありがたい。 開発者だったら覚えておいても損はないですな。 API f... 続きを読む

数十兆円市場のテレコム関連市場に狙い：クラウド電話APIのTwilioが日本上陸、創業CEOに聞いた - ＠IT

2013/04/17 64 users Twilio トゥイリオ 米Twilio 一角 イノベーション

巨大なテレコム市場の一角で破壊的イノベーションを起こしつつあるTwilio（トゥイリオ）が、いよいよ日本に上陸した。2012年10月に業務提携を発表していたKDDIウェブコミュニケーションズと米Twilioの2社は、2013年4月17日から日本国内でも“クラウド電話API”と彼らが呼ぶ「Twilio」の提供を開始すると発表した（プレスリリース）。APIドキュメントの日本語化も完了していて、今後はK... 続きを読む

多数の言語のAPIドキュメントを一元管理「DocHub」 - MOONGIFT|オープンソース・ソフトウェア紹介を軸としたITエンジニア、Webデザイナー向けブログ

2012/07/28 56 users MOONGIFT プログラミング 一元管理 ITエンジニア

プログラミングをある程度やっていると、解決法を探すのにAPIドキュメントを当たるのが一番早くなっていきます。そこで社内でも使えるAPIドキュメントサーバとしてDocHubを紹介します。 0 続きを読む

JavaScriptによる開発が大規模化したらドキュメントを生成「Dox」 | MOONGIFT | オープンソース・ソフトウェア紹介を中心としたITエンジニア/Webデザイナー向けブログ

2011/02/01 76 users MOONGIFT コーディングスタイル ドキュメント 生成

DoxはJavaScript/node.js製のオープンソース・ソフトウェア。JavaScriptがWebアプリケーション構築の際のメイン言語として使われるようになっている。その結果起こっているのがJavaScriptのコードの大規模化だ。トップページ大規模になれば当然、複数人での開発体制になる。そうなれば情報の共有やコーディングスタイルの統一などが必須になる。その一端を担うのがAPIドキュメント... 続きを読む

最人気Ajaxフレームワーク最新版Prototype 1.5 - 待望のAPIドキュメントも (MYCOMジャーナル)

2007/01/22 122 users MYCOMジャーナル 待望

Sam Stephenson氏は18日(米国時間)、Prototype 1.5を公開したことを明らかにした。PrototypeはJavaScriptによる軽量Ajaxフレームワーク。Prototypeは2006年9月23日(米国時間)に公開された「Ajaxian.com 2006 Survey Results」の調査結果において、もっとも人気があるAjaxフレームワークとされており、注目のバージョ... 続きを読む