タグ

ドキュメントに関するsugimoriのブックマーク (4)

  • Spring REST Docs によるAPI仕様書自動化

    こんにちは。サーバサイドエンジニアをしている大堀です。 今回は、私が所属しているプロジェクトで導入しているSpring REST Docsによる、 API仕様書自動化方法に関して紹介します。 導入するに至った背景 私が今までのプロジェクトでは、APIドキュメントを手動で作成していましたが、 記入ミスや、時間が経つにつれて更新が滞ったり、実装と異なってくるという問題が生じていました。 そこで、Spring MVCの枠組みで作成されたアプリケーションから、 自動でドキュメントを生成してくれるSpring REST Docsを導入することにしました。 Spring REST Docsについて Spring REST DocsはRESTfulなサービスのドキュメントを生成するツールです。 Spring MVC Testで書かれたテストを通った場合、HTTPリクエストやレスポンス等が記載されたsni

    Spring REST Docs によるAPI仕様書自動化
    sugimori
    sugimori 2017/04/25
    こういうの使えないのかな?
  • The Twelve-Factor App (日本語訳)

    はじめに 現代では、ソフトウェアは一般にサービスとして提供され、Webアプリケーション や Software as a Service と呼ばれる。Twelve-Factor Appは、次のようなSoftware as a Serviceを作り上げるための方法論である。 セットアップ自動化のために 宣言的な フォーマットを使い、プロジェクトに新しく加わった開発者が要する時間とコストを最小化する。 下層のOSへの 依存関係を明確化 し、実行環境間での 移植性を最大化 する。 モダンな クラウドプラットフォーム 上への デプロイ に適しており、サーバー管理やシステム管理を不要なものにする。 開発環境と番環境の 差異を最小限 にし、アジリティを最大化する 継続的デプロイ を可能にする。 ツール、アーキテクチャ、開発プラクティスを大幅に変更することなく スケールアップ できる。 Twelve-F

  • Increments は和製 GitHub の夢を見るか? - @kyanny's blog

    Quipper では日オフィスの開発者を中心に、 Qiita::Team を導入して社内のドキュメント共有を行なっている。書かれる内容は日報が多いが、技術 Tips の共有やチャットでは適切でない込み入った技術的問題を解決する議論の場としても活用している。 なぜわざわざドキュメント共有?ていうか日報書くなんてダサすぎじゃね?そう思ったあなた、日報を見くびっちゃいけません。上手に運用すればナレッジシェアやコラボレーションのみならず、チームビルディングにも役立つんです。 上手に運用された日報には前例がある。ペパボの社内 SNS であるタンパクがそれだ。毎日スタッフ全員が日報を書くきまりなのだが、来の目的である業務内容の記録以外に一言コメントを書く欄がある。定型文で済ます人もいればブログ並の長文を書く人もおり(それはわたしです!)、これがそこらの SNS なんかよりよっぽど面白いコンテンツな

    Increments は和製 GitHub の夢を見るか? - @kyanny's blog
    sugimori
    sugimori 2014/01/22
    ブログで日報を書きながら仕事をするというスタイルをやってみたい。
  • 日本語ドキュメント - Apple Developer

    語ドキュメント 日語に翻訳されたiOS/watchOS/tvOSのドキュメントです。 英語版の方が新しい場合がありますので、更新日を確認して下さい。 エンタープライズ環境での運用に関するドキュメントはこちらに移動しました。 App Store Connect ヘルプ タイトル 日付

  • 1