search

Apipie / apipie-rails

Ruby on Rails API documentation tool
Apache License 2.0
2.47k stars 459 forks source link

Question about maintains #175

Open artempartos opened 10 years ago

artempartos commented 10 years ago

I think this gem is very usefull. There are a lot of issues and pull requests, but you are not react. Can you add some active collaborators?

iNecas commented 10 years ago

Hi,

First of all I'm glad you find the project interesting and care about it's future. I'm probably personally guilty of apipie not getting as much attention as it deserves (based on the feedback).

We use it quite extensively in Foreman and Katello projects and use it for things like reducing the duplicity between CLI and API in Hammer CLI.

Because of the open-source basis of those projects, it probably makes much sense to find more core contributors among them. I would also welcome others suggestions on building better ecosystem and community around apipie.

I'm helding a hangout on some of the apipie internals on Monday (2:30 PM GMT), if interested, you (anyone) can join us, more details on #theforeman Freenode channel. We will be talking mainly about using apipie in cases where some api is added to the app as Rails engine, also about dynamic generation of API bindings etc, but we'll probably talk about the improving the maintenance as well.

freemanoid commented 10 years ago

@artempartos :+1:

kevTheDev commented 10 years ago

hi,

was there any outcome on the use of apipie where the api is added to a rails app as an engine?

cheers

kev

freemanoid commented 10 years ago

@kevTheDev, why not?

iNecas commented 10 years ago

@kevTheDev hi. It depends:

  1. if the original app has already apipie configured and API added by the engine should appear in the api docs of the orignal app, then the original app's apipie config should have the api_controllers_matcher saved as array and the engine should << to this config it's paths to API controllers in intializer phase
  2. if the original app has no apipie at all, then you can use apipie directly form your engine, as it was in your app: the problem is if more engines are involved: for now you can have only one apipie doc set in the rails app
  3. if the engine wants it's separate set of docs, for now there is no way to have that served dynamically, but you can still generate the docs with rake apipie:cache or rake apipie:static with having the api_controllers_matcher set just to the engine paths when generating the docs.

In our case (the Foreman and engines extending the API), we will go with 1. as it's still one API and for us it's good to have all the docs on one place

danbartlett commented 9 years ago

Yes, I would like to help with the project too, but it is discouraging when you see old PRs and issues with no response :(