{"action":"closed","issue":{"url":"https://api.github.com/repos/saamo/api-doc-test/issues/2","labels_url":"https://api.github.com/repos/saamo/api-doc-test/issues/2/labels{/name}","comments_url":"https://api.github.com/repos/saamo/api-doc-test/issues/2/comments","events_url":"https://api.github.com/repos/saamo/api-doc-test/issues/2/events","html_url":"https://github.com/saamo/api-doc-test/issues/2","id":100846633,"number":2,"title":"Make the use of this package more user friendly","user":{"login":"arturmuller","id":3978227,"avatar_url":"https://avatars.githubusercontent.com/u/3978227?v=3","gravatar_id":"","url":"https://api.github.com/users/arturmuller","html_url":"https://github.com/arturmuller","followers_url":"https://api.github.com/users/arturmuller/followers","following_url":"https://api.github.com/users/arturmuller/following{/other_user}","gists_url":"https://api.github.com/users/arturmuller/gists{/gist_id}","starred_url":"https://api.github.com/users/arturmuller/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/arturmuller/subscriptions","organizations_url":"https://api.github.com/users/arturmuller/orgs","repos_url":"https://api.github.com/users/arturmuller/repos","events_url":"https://api.github.com/users/arturmuller/events{/privacy}","received_events_url":"https://api.github.com/users/arturmuller/received_events","type":"User","site_admin":false},"labels":[],"state":"closed","locked":false,"assignee":null,"milestone":null,"comments":2,"created_at":"2015-08-13T19:13:48Z","updated_at":"2015-09-04T15:03:13Z","closed_at":"2015-09-04T15:03:13Z","body":"As I was reading though the examples I have noticed that it is kinda awkward that I always have to hunt down where the apiDocTest function is called. There is a lot of reliance on the user doing things before they can plug them into the function, when I think most of these could be handled by the package itself. (Maybe I am missing something?)\r\n\r\nThe promise of this package is to generate an API Blueprint, so that is the 'edge' of this package in my eyes and you don't have to be modular beyond that I think. After all, if the user needs something more specific, they can always use Acquit or something like that directly — this should be pretty plug'n'play imo.\r\n\r\nAnyways, so what if the api was something more along the lines of:\r\n\r\n```javascript\r\nvar generateDocs = require('api-doc-test');\r\n\r\nvar header = {\r\n  title: 'Lobster Chat API',\r\n  description: 'This API provides access to the Lobster Chat messaging service.',\r\n  metadata: {\r\n    format: '1A',\r\n    host: 'http://api.lobsterchat.com/'\r\n  }\r\n}\r\n\r\ngenerateDocs(header, './**/*.test.js');\r\n\r\n```\r\n\r\nI guess you should also somehow deal with where the output goes and how the generated file is called but I think the above is hopefully enough to get my point across.\r\n\r\nWhat do you think?"}}