タグ「APIドキュメント」

タグ APIドキュメント

新着順人気順 5 users 10 users 50 users 100 users 500 users 1000 users

(1 - 17 / 17件)

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

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

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

Rails: Active Record属性のデフォルト値はコールバックよりもdefaultオプションで設定しよう（翻訳）｜TechRacho by BPS株式会社

2023/06/19 9 users Rails Andy Croll 許諾原著者翻訳

概要原著者の許諾を得て翻訳・公開いたします。英語記事: Assign a default value to an attribute in Active Record – Andy Croll 原文公開日: 2023/03/13 原著者: Andy Croll 日本語タイトルは内容に即したものにしました。以下のAPIドキュメントもどうぞ。 Rails: ActiveRecord標準のattributes APIドキュメント（... 続きを読む

AWS版「GitHub Copilot」な「Amazon CodeWhisperer」が正式版に　個人ユーザーは無料、VSCodeに対応

2023/04/14 10 users AWS フォーラムプログラミング vscode 機械学習

参考：AWSも、プログラミングを機械学習で支援する「Amazon CodeWhisperer」プレビュー公開。コメントを書くとコードを提案コメントや書きかけのコードからコードを自動生成 Amazon CodeWhispererは、オープンソースリポジトリ、Amazon内部リポジトリ、APIドキュメント、フォーラムなどから収集した数十億行のコードを... 続きを読む

documentationjs + add-text-to-markdownでREADME.mdのAPIリファレンスを自動更新 | Web Scratch

2019/01/03 27 users Markdown JSDoc TypeScript 出力

documentationjsはJSDocからドキュメントを生成できるツールで、ES2015以降のコードにも対応しています。 (TypeScriptは対応してないようです) 以前はMarkdownへの出力が難しかったのですが、いつのまにかdocumentation build -f mdでMarkdownでのAPIドキュメントが生成できるようになっていました。これを使うことで、... 続きを読む

｢mackerel-plugin-nature-remo｣書いた - Masteries

2018/02/22 13 users Masteries Nature Nature Remo

2018 - 02 - 22 ｢mackerel-plugin-nature-remo｣書いた最近, いろいろあってNature Remoを購入しました. nature.global 購入してから知ったのですが, Nature Remoは温度と湿度が測定出来るようになっていて(湿度は10%刻みの概算値ですが), これもちょうど最近公開された APIドキュメントを見ていたところ, Nature ... 続きを読む

｢mackerel-plugin-nature-remo｣書いた - Masteries

2018/02/22 13 users Masteries Nature Nature Remo

[TensorFlow] APIドキュメントを眺める -Tensor編- ｜ Developers.IO

2015/12/11 31 users TensorFlow Tensor README.md 予習

はじめに TensorFlow研究会に先立ち、予習をしておこうと思い、まずは GithubリポジトリのREADME.mdを試してみたあと、 APIドキュメントを眺めてみました。まずはぱっと目についた Tensor クラスを一通り通読したのでまとめてみます。 Tensor について Tensor (Tensor クラスのインスタンス)は TensorFlow の名前の由来でもあり、数学で言... 続きを読む

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 ... 続きを読む

Jdoc - JSON SchemaからAPIドキュメントを生成 MOONGIFT

2014/06/23 37 users MOONGIFT JSON JSON Schema 生成普及

JSONがWeb APIのデータ送受信フォーマットとして活用されるようになると、受け取る側と発信する側でその内容が適切であるかどうか検証する手段が必要になります。それがJSON Schemaです。 2009年頃に登場したようですが、当時は面倒がってあまり使われてきませんでしたが、JSONの普及ともとに注目が集まっています。そんなJSON Schemaを開発者にも優しいフォーマットに変換してくれるの... 続きを読む

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

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

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

TypeScriptのAPIドキュメントをyuidocjsで自動生成 - 成らぬは人の為さぬなりけり

2013/06/24 39 users TypeScript Javadoc rdoc npm 仕事

2013-06-22 TypeScriptのAPIドキュメントをyuidocjsで自動生成 TypeScript Node.js 現在、仕事でTypeScriptを使っていますが、 APIドキュメントが欲しくなってきて、 JavaDocとか、RDocとか、ScalaDocとか、みたいに自動生成させたいなぁと思い、いろいろ試してみました。試したツール jsdoc (npm) JsDoc Tool... 続きを読む

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フレームワークとされており、注目のバージョ... 続きを読む

(1 - 17 / 17件)