stuf / masayards-calmm

An attempt at a sane alternative viewer for Kantai Collection (艦隊これくしょん)
MIT License
5 stars 0 forks source link

Create API reference documentation for both the game API and application data #5

Open stuf opened 7 years ago

stuf commented 7 years ago

Create a basic set of documentation that can work as reference for both the incoming data from the game API as well as document the data types and structures used internally in the application. Additionally, supply some model data that can also be used for creating tests.

This is a huge time-saver, since this will allow for tests to be written out and have the handling of data tested without having to trigger API actions to see if something works or not. Especially in the case of some actions that can only be done a limited amount of times during a day.

stuf commented 7 years ago

Base for the KCS API has been started in the flow typedefs found in kcsapi.js. Base documentation should be generatable based on these.