ty10r / canapi Goto Github PK

I would like to create a test suite that tests all management functions.

• User login test script
• API validation test script
• Requestlog test script
• OAuth required test script
• Unit tests

Get endpoints should all have validation on their query parameters.

• create query parameter validation functions
• create mapping between parameter types and their validation functions
• in ApiProxy.prototype.makeRoute call each validation function on parameters, using the mapping

Title only says Get Query Params, but I will leave this here because it will use the same code:

• in ApiProxy.prototype.makeRoute call each validation function on POST parameters

Create a rate limitting middleware to be configured in server config.

• Implement rate limiter
• Add configuration options to server config for rate limiter
• Refuse requests beyond rate limit

• Implement a REST API for the saved data about requests sent through Canapi.

Server configuration should define multiple parameters for the server.

• Starting APIs with their relative subpaths and the path to their raml files
• details on how to protect each api

Currently, post parameters are not validated.

This is specifically because of the issue at:
raml-org/raml-js-parser#115

Embedded schema parsing will need to be fixed on the javascript raml-parser before I can validate the github api post parameters.

URI Parameters are working in path segments, but not in cases like Twitter's {mediatype} fields.

This means paths that can be /resourceName or /resourceName.json are broken.

To save time, I haven't thought much about the error reporting system of this project.
I would like to abstract the error reporting throughout Canapi to make it more uniform from user's perspective and cleaner from a coder's perspective.

Decide whether to use Memcache or Reddis for a request caching layer.

• Implement a cache layer for Canapi
• Implement conditional requests using Canapi cache layer

At the moment all API Proxies are made at server start. This doesn't have to be the case.
I would like to make a set of IP Protected endpoints that would allow a Canapi's admin to post a RAML file and API Proxy configuration to add API Proxies at runtime.

• Create IP whitelisted endpoints
• POST Endpoint for RAML file and server config
• Create API Proxy at runtime

I need to make a means for my application to go through github OAuth2_0 verification.
This will allow all endpoints to be sent with a user's oauth token.

• Send back authentication to local user endpoint in a cookie
• Implement small test script which can hold authentication cookie for subsequent requests
• Implement OAuth2.0 call flow with github (Try to base functions on raml so this can be used for others later)
• Test Oauth flow as enduser to my api gateway