「技術報告」一覧

[API] 　仕様書　作成方法　フォーマット

2017/11/12 2022/11/20 技術報告

こちらのサイトを参考にさせていただいております。

https://qiita.com/sunstripe/items/9230396febfab2eae2c2

API一覧

API一覧

No.	API機能No.	種別	API名	機能概要
0	API_LOGIN	API	例	例
1	HOGE-001	API	ほげほげ	ほげほげする
2	HOGE-002	API	ほげほげ	ほげほげする
3	HOGE-003	API	ほげほげ	ほげほげする

LOGIN-001

API機能No.	HOGE-000
API名	ログイン制御
更新日/更新者	20XX.XX.XX 担当者名
概要

入力
アクセスURI	api/hoge/search

リクエストパラメータ（クライアントから送るほう）

POSTデータ（JSON形式）

JSON Key	型	サイズ	必須	暗号化	検索条件	値の説明
user_id	文字列	10	○		完全一致	半角数字10桁

レスポンスパラメータ（戻ってくるやつ）

出力

返却データ（JSON形式）

JSON Key	型	サイズ	必須	値の説明
status	数値		○	処理結果ステータス
messages	配列			エラーメッセージ群
result	配列			検索結果は配列
hoge_id	数値	10		ほげのID
hoge_type	数値	1		ほげの識別番号
hoge_title	文字列	150		ほげのタイトル
hoge_body_text	文字列			ほげの本文
hoge_display_date	文字列	10		表示日時日付形式（YYYY/MM/DD）

メッセージ

処理結果ステータス

ステータス	共個	メッセージ内容(message)
1	個別	検索結果が1件以上の場合 => {“メッセージなし。”} 検索結果 0 件の場合 => {“該当する情報はありませんでした。”
200	共通	ログアウトしています。
300	個別	{ “○○は必須です”, “△△は数値ではありません”} ※ 項目毎のエラー内容を返却
600	個別	{“サーバで認証エラーになりました。”}
999	共通	{“システムエラーが発生しました。”}

メルマガ登録をお願いします。

素敵な？情報がいつもあなたに届くようになります。（itmnewsの記事が届きます。）お役に立つかどうかわかりませんが頑張りますっ。登録してみてください。

PUSH7

2017/10/27 2017/10/28 技術報告

PUSH通知ができるサービス

https://push7.jp/

PUSH通知とは、ユーザーが自分から取りに行くのではなく、提供者から、ユーザーへ送信する伝達手法。

PUSHの逆はPULLです。ブラウザを利用したインターネットの情報は、PULL（自分から取りに行っています）それが基本です。それが、取りに行かなくても相手が教えてくれるのが
このPUSH機能ですね。

おそらくですが、乱立させると不要なPUSHと必要なPUSHを見分けることができず、埋没する恐れがあるので、ある程度のユーザー側の制御は、提供側のマナーは必要になってきそうですね。

「より注意をひくことができる」しくみは、生活ツールやタスクツールにはよいですね。

メルマガ登録をお願いします。

元仕事仲間に久々会いました

2017/10/27 技術報告

最初に勤めた会社の同僚がうちの事務所に遊びに来てくれました。

私と同時期くらいに独立しているのですが、年商がまちがいなく億は超えている。

何が違うのかといったところ、

まず、SESベースの仕事体形。

創業数年で１０人以上の体制で、大手企業に常駐する

という、大手の企業のコネを独立前に作っているのと

人材を常駐させ、その差分で毎月利益が生まれるキャッシュフローが

明確。

そして、目指している到達点が私と一緒。

オリジナルサービスで収益を生む。

私の場合は、そのために、請負の仕事をしながら、自分で

ネタを作って蓄えている。

友人の場合は、まず、SESで自社コンテンツを作る体力を作ってから

一気に売り出す。

私の場合は、自分のキャパの中でのコンテンツ作り。

友人の場合は数十名常駐し、その利益で社内の残る数名に投資し

コンテンツを作る。

まったく違うルートとスケール感ですが、志が同じなので、

いつも良い刺激になりますね。