steemit
Doc precision
Provide a more precise methods documentation.
Expected behavior
-
Method name
-
Method description
-
Method code with parameters
-
Method parameters detail
Actual behavior
Method name
Method code with parameters
How
B.E.
Follow API
Get Followers
Return account followers.
steem.api.getFollowers(following, startFollower, followType, limit, function(err, result) {
console.log(err, result);
});
following: [String] -> 'fabien'
startFollower: [String] -> '' || 'fabien'
followType: [?] -> null
limit: [Number] -> '0', '100'
I think it would be easier to take in hand the API.
An example could also be great.
If this is accepted, I will do it when I will have the time.
I agree, that would be great to have more information on the documentation. If you do it we will accept your PR. good-karma been working on something similar Steem API tester: https://esteemapp.github.io/steemapi/#!/Account/get_get_followers. There is some descriptions and default parameters of the methods, this can help for building Steem.js doc.
Hello together,
I just saw this ticket and I guess this is a problem that everyone providing an API wrapper is fighting with. I develop SteemJ which is the Steem API wrapper for Java and I also had to start documenting everything in the Wiki. I guess this is the same case of steem-python and radiator (the api wrapper for ruby) and all the other wrapper too.
For sure fields are accessed in a different way in each programming language, but the available fields are the same for all of us as we all work against the Steem api. Therefore, what do you think of having a centralized documentation for the api? I guess this would help us, the developers, and the users for sure...
I'm going to put some time into improving the documentation. In the short term by hacking at the doc/README/md file. I don't expect to complete the API documentation, but I can at least make a start.
@timcliff on steemit has expressed interest in updating central developer docs. The best place for swagger/openapi specs is where the API is published, not within a language binding project like steem-js.
