Skip to content

Commit

Permalink
feat: doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
Cristian Vidmar committed Mar 11, 2022
1 parent 03be86b commit a2b22f5
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,9 +260,15 @@ enviroment calling the SetEnviroment method. See documentation below.

### Unit tests

You'll write your own unit tests using the generated code, but the generator itself will need some good tests. These require a non-trivial set of data and a pass-through HTTP connection to load it from the filesystem instead of the network. It's all in the plan, hang on.
As of v1.0.6 gocontenful can generate the API files also from a local export
JSON file (through the `-exportfile` command line option)
and it includes both a sample export file (`./test/test-space-export.json`) and
a test suite you can run with

_@TODO: add sample space data and unit tests_
`make test`

This generates the API in the test/testapi folder and runs a dozen unit tests to
make sure everything is working correctly.

Public functions and methods
---------------------
Expand Down

0 comments on commit a2b22f5

Please sign in to comment.