Bluetooth를 사용한 API 문서 구성

7037 단어 DockerBlueprint
안녕하세요@xsota.
문서가 없는 API를 사용하여 프런트엔드 개발을 수행하는 것은 어렵기 때문에 문서를 준비하십시오.
따라서 API 문서를 작성하려면 단계를 남겨두십시오.
GiitHub Pages 등을 통해 확인하고자 API Blueprint를 사용해 HTML에서 생성될 수 있도록 규격서를 써봤다.

docker 모드 사용


많은 곳에서 노드, 글로프 같은 것을 준비할 것 같아서 먼저 준비했다docker image.
docker-compose.이런 느낌으로yml를 쓰세요.
docker-compose.yml
version: "3"

services:
  app:   
    image: xsota/blueprint-gen
    volumes:
      - ./md:/md
      - ./public:/public
향상
$ docker-compose up -d
나는md 디렉터리가 있다고 생각하기 때문에md 디렉터리에서 다음과 같은 내용으로 파일을 만듭니다.
이것은 설명서입니다.
설명서의 상세한 규격은 확인해 주십시오https://apiblueprint.org/.
examole.md
FORMAT: 1A
HOST: http://example.com/v1

# Auth
## login [/auth/login]
### POST
#### 概要
emailとpasswordでログインを試みる。
成功した場合アクセストークンやらなんやらが返る。


- Request (application/json)
    - Attribute
        - email: [email protected] (required) - メールアドレス
        - password: h0g3Ho9e (string, required) - パスワード


- Response 200 (application/json)
    - Attribute
        - auth_token: 4uThT0K3n - auth token
md 디렉터리 이하의 .md 파일을 감시하고 있기 때문에 파일을 저장할 때 공공에서 html 파일을 생성해야 합니다.
다음 그림과 같이 하십시오.
$ tree
.
├── docker-compose.yml
├── md/
│   └── example.md
└── public
    └── example.html
    
만약 생성docker-compose logs이 없다면 원인을 조사하고 방법을 강구하여 해결하십시오.
생성된 HTML은 이런 느낌으로 표시됩니다.
https://xsota.github.io/dockerfiles/blueprint-gen/public/v1/example.html

docker 모드를 사용하지 않음


나는 docker를 사용하고 싶지 않다.이런 사람은 아래의 순서에 따라 스스로 하세요.
설치가 많다.
$ npm install -g gulp
$ npm install gulp gulp-watch gulp-aglio
gulpfile.제작무엇이gulp입니까?불평을 늘어놓다.
gulpfile.js
var gulp = require('gulp');
var aglio = require('gulp-aglio');
var watch = require('gulp-watch');

var src = 'md/**/'
var dest = 'public'

gulp.task('publish', function () {
    gulp.src(`${src}*.md`)
        .pipe(aglio({ template: 'default' }))
        .pipe(gulp.dest(dest));
});

gulp.task('watch', function() {
    return watch(src, () => {
    return gulp.start(['publish']);
    });
})
그리고 바로 글립 워치 같은 거 해주세요.
$ gulp watch
glop 안 써도 돼요.
아마 이것이 가장 간단한 방법일 것이다.
$ npm install -g aglio
$ aglio -i md/example.md -o public/example.html
이런 느낌으로 API 문서를 정비하면 상속 기간도 줄어들 것 같아 다들 좋아하시잖아요.
글쎄, 나는 문서를 만들어 본 적이 없어서 잘 모르겠어.

좋은 웹페이지 즐겨찾기