mitsuruog / api-first-spec-to-swagger

Swagger JSON Converter for api-first-spec
MIT License
4 stars 1 forks source link

Problem with codecheck project #1

Open shunjikonishi opened 8 years ago

shunjikonishi commented 8 years ago

とりあえずまとめて

生成されたHTMLはrequest parametersはかなり良い感じですが、responseの方は若干見にくいです。

mitsuruog commented 8 years ago

@shunjikonishi ありがとうございます!

READMEでは「options.output」となっているが、実際には「options.o」

その通りですね。

grunt taskとして動かそうと思ったらglobのバージョンが古いせいかうまく動かなかった

こちらは現在あまり想定していなかった利用ケースなので、gruntのバージョンと実際の定義を見せてもらえると助かります。

codecheck.jsではspec.jsにmochaのテストも併記している(これがそもそも良くないという話はあるが。。。)ため、describeがないと怒られる

「これがそもそも良くないという話はある」ここは同意しますし、converter作成する上で一番悩んだポイントでした。ひとまずapi-first-spec-to-swaggerの内部でsinon.jsを使っているので、describeをモックしようかと思います。

request.paramsはない場合があるのでparameterObjectでエラーが発生する

承知しました!

generated >> docs/apiが出力された後何故かプロセスが終了しない

これは今までなかったですね。おかしい。

生成されたHTMLはrequest parametersはかなり良い感じですが、responseの方は若干見にくいです。

確かにそうですね。responseのHTMLに関してはカスタムすることはできるので工夫します。