72pulses / apidoco Goto Github PK

View Code? Open in Web Editor NEW

72.0 8.0 17.0 1.6 MB

Ruby on Rails API documentation tool

Home Page: https://apidoco-demo.herokuapp.com/docs/apis/v2

License: MIT License

Ruby 57.38% JavaScript 16.51% CSS 7.72% HTML 18.40%

ruby ruby-gem rails-engine api-documentation-tool rails

apidoco's Issues

Build documentation generator

See https://github.com/alameenkhader/apidoco/issues/3

It looks like example can't include response headers
Is there a way to document the response headers?
There should be as for api auth responses.. i'm using devise_token_auth and they give the token info in the response headers.

Apidoco::Documentation

See https://github.com/alameenkhader/apidoco/issues/3

Add description to parameter

Filter APIs

Angular DOM filtering

Fix vulnerability dependencies reported by github

https://github.com/72pulses/apidoco/network/alerts

.DS_Store files inside api folders screw with JSON parsing.

What a mission that was to figure out!
Especially due to .DS_Store files no longer showing in finder (even when showing dotfiles 🙄)
Not sure if this is really an issue, but worth noting anyway.

Thanks for the great gem!

Sprockets::FileNotFound in Apidoco::Apis#show

couldn't find file 'angular/1.8.0/angular' with type 'application/javascript'

// about supported directives.
//
//= require angular/1.8.0/angular < ------- error
//
//= require apidoco/jquery.min
//= require apidoco/jquery.json-viewer

Alphabetical Ordering Of Endpoints

The endpoints are out of order, currently not being sorted alphabetically.

Is there an option to specify the ordering of endpoints?

[Question] Does this gem works on "api-only" mode?

I tried using the gem in and old project that uses the api only mode in rails but when I access the /docs route it shows just the HTML with angular tags. So... Does the gem work with this type of API?

It shows like this in my localhost

The project configs are:

ruby: 2.4.9
Rails: 4.2.3

Thanks for the attention!

Not loaded assets

This is error in console browser :

GET http://localhost:3000/stylesheets/apidoco/application.css net::ERR_ABORTED
GET http://localhost:3000/javascripts/apidoco/application.js net::ERR_ABORTED

ApiDoco::VersionParser

See https://github.com/alameenkhader/apidoco/issues/3

Test Coverage

Set Up Rspec
Cover Generators
Feature Tests
Unit Tests

New CSS theme

Specifying the "direction" of the parameter.

I'd like to specify in the parameters for a request, or for a response to a request.

for example, to inform that the parameter is optional or to describe it.

In examples of requests, the essence of one or another parameter (in response to a request) may not always be clear.

<head>
  <title>Apidoco</title>
  <%= stylesheet_link_tag "apidoco/application", media: "all" %>
  <%= javascript_include_tag "apidoco/application" %>
  <%= csrf_meta_tags %>
</head>

https://github.com/72pulses/apidoco/blob/master/app/views/layouts/apidoco/application.html.erb

Documentation Version Parser

This is the milestone issue which focuses on building the following

Rails generator to create the sample API documentation files and folders
Classes to parse these version-ed documents

Directory structure for documentation

docs
---api
------v1
---------posts
------------create.json
------------list.json
------------show.json
------------update.json
------------delete.json
---------comments
------------create.json
------------delete.json
------v2
---------posts
------------create.json
------------list.json
------------show.json
------------update.json
------------delete.json
---------comments
------------create.json
------------delete.json

Classes

Apidoco::Documentation - parsers all the files of the specified documentation folder(ex:- v1)
ApiDoco::VersionParser - keeps track of all the Documentations(ex:- should have an array of all the Apidoco::Documentation versions)

Tasks

Generator - https://github.com/alameenkhader/apidoco/issues/4
Apidoco::Documentation - https://github.com/alameenkhader/apidoco/issues/5
ApiDoco::VersionParser - https://github.com/alameenkhader/apidoco/issues/6

72pulses / apidoco Goto Github PK

apidoco's Issues

Directory structure for documentation

Classes

Tasks

Recommend Projects

Recommend Topics

Recommend Org