<div id="readability-page-1" class="page"><div><h3 id="readme">Readme</h3>
<p>토이 프로젝트 Readme 파일에 대해 고민해 본다. 첫 단락에 이 프로젝트가 어떤 문제를 해결하는지 기술하면 가장 좋다고 생각된다. 대충 뭔가 하게는 만들었는데 무슨 문제를 해결하는지 정확히 모르겠다. 다시 돌아가야 겠다. 문제를 만나야 한다.</p>
<h3 id="이렇게-간단하게-된다고">이렇게 간단하게 된다고?</h3>
<p>AWS EC2 인스턴스를 생성하고, 로드 밸런서로 부하를 분산하거나 장애에 대응하는 방법, Auto Scailing 그룹을 사용해 자동으로 스케일 아웃되게 하는 방법을 읽는다. 그리고 도커 파일을 생성하고 관리하는 기초적인 내용도 읽는다. 이 모든게 이렇게 간단하게 된다고?</p>
<h3 id="좋은-restful-api-모습은">좋은 RESTful API 모습은?</h3>
<p>파일 업로드, 다운로드 REST API를 구상하다가 어떻게 하는게 잘한건지 도무지 모르겠어서 책을 한 권 빌렸다. 거기서 POST 는 멱등성을 보장하지 않는 안전하지 않은 생성 동작이지만 정말 다양한 모습으로 사용되는 모든 것을 할 수 있는 메서드라는 설명이 있었다. 한마디로 표준이 없다고 했다. 그래서 그냥 내가 사용자라면 이런 모습이면 기억하기 쉽고, 사용하기 쉬우며, 누군가에게 설명하기도 괜찮겠다 싶은 모양으로 URL과 바디의 표현 구조를 변경했다. 이 정도면 됐다.</p></div></div>

Joo's Work

JooSing

Readme
토이 프로젝트 Readme 파일에 대해 고민해 본다. 첫 단락에 이 프로젝트가 어떤 문제를 해결하는지 기술하면 가장 좋다고 생각된다. 대충 뭔가 하게는 만들었는데 무슨 문제를 해결하는지 정확히 모르겠다. 다시 돌아가야 겠다. 문제를 만나야 한다.
이렇게 간단하게 된다고?
AWS EC2 인스턴스를 생성하고, 로드 밸런서로 부하를 분산하거나 장애에 대응하는 방법, Auto Scailing 그룹을 사용해 자동으로 스케일 아웃되게 하는 방법을 읽는다. 그리고 도커 파일을 생성하고 관리하는 기초적인 내용도 읽는다. 이 모든게 이렇게 간단하게 된다고?
좋은 RESTful API 모습은?
파일 업로드, 다운로드 REST API를 구상하다가 어떻게 하는게 잘한건지 도무지 모르겠어서 책을 한 권 빌렸다. 거기서 POST 는 멱등성을 보장하지 않는 안전하지 않은 생성 동작이지만 정말 다양한 모습으로 사용되는 모든 것을 할 수 있는 메서드라는 설명이 있었다. 한마디로 표준이 없다고 했다. 그래서 그냥 내가 사용자라면 이런 모습이면 기억하기 쉽고, 사용하기 쉬우며, 누군가에게 설명하기도 괜찮겠다 싶은 모양으로 URL과 바디의 표현 구조를 변경했다. 이 정도면 됐다.

개발일기 #120 : Readme

댓글