Open fornwall opened 4 years ago
Added a bunch of suggestions under four different categories: For meeshkan record
, For meeshkan build
, For meeshkan mock
and General documentation improvements
.
There are still two bugs that I need to file which will also potentially inform this list. One is related the differences between build modes (gen
and replay
) and the other is related to meeshkan record
recognizing integers in query params.
Things to discuss:
This is a collection of tasks that can be done for improving the initial impressions of running meeshkan.
Some possible ones:
meeshkan --help
andmeeshkan CMD --help
and see if things can be improved (#124).For
meeshkan record
:spec generation mode disabled
and I was like uhhhh what is this, is it bad 😆 Could be good to clarify for users what this means.logs
andspecs
)ctrl + c
or akill
command - but that's not written anywhere. It'd be nice to have that documented or, even better, have astop
command (Documented in #144, but still in favor of astop
command)For
meeshkan build
:-o
and-a
) (#144)For
meeshkan mock
:-s
flag is doing in mock command example in MOCK.md (In https://github.com/meeshkan/meeshkan/commit/608524e86f19fbdbda107f2ca509f1a62965e0c9 we write out--specs-dir
)servers
field in OpenAPI spec to find the URL for the mock server to respond to. But I only knew to do that because Mike told me to. We should clarify in docs that this is located there and that it will usually be the same url as the API itself, unless you hack it. We haven’t mentioned hackability much in the existing documentation. If we write out the endpoints at startup, then this is less of a problem. See also the next note about logging endpoints at startup. Solved by #142.http://localhost:9000/http://myapi.com/path/to/api
, perhaps usehttp://localhost:9000/path/to/api
without the host (that's what prism and mocklab does at least).specs
. Or remove the default completely (Removed default in #154)--specs-dir
as an option, and instead take it as an argument. So run it likemeeshkan mock directory
instead ofmeeshkan mock --specs-dir directory
(#154) (documented in #144)meeshkan mock file-or-directory
(#154)General documentation improvements:
--admin-port
instead of-a
) in documentation (#144)--help
output.When working on this, let's create links to PR:s and concrete issues to visualise what has been done and ideas for further improvements.