Coder Social home page Coder Social logo

Routes about api HOT 2 CLOSED

joshghent avatar joshghent commented on August 14, 2024
Routes

from api.

Comments (2)

joshghent avatar joshghent commented on August 14, 2024 1

Ok I've finally added swagger docs so hopefully we can all get cracking on it! 💯

from api.

joshghent avatar joshghent commented on August 14, 2024

Ok these are the routes we will make. This will need converting to swagger documentation and add payloads to the post/update routes etc.
All private methods use JWT authentication
Public methods use something else (possibly JWT but the account information will not be needed)

PRIVATE - Create user, update, patch, delete
/user

PRIVATE - Create fiddle, GET fiddles for user
/fiddles

PRIVATE - get single fiddle, update delete
/fiddle/:fiddleid

PUBLIC - Get recent fiddles
/fiddles/recent/:dateRange

PUBLIC - Get most starred
/fiddles/popular/:dateRange

PRIVATE - Toggle Starring a fiddle - jwt auth (this is how we get the user that has starred the fiddle)
/fiddles/:fiddleid/star

PRIVATE - Fork a fiddle
/Fiddles/:fiddleid/fork

PRIVATE - Tag a fiddle
/Fiddles/:fiddleid/tag
Post the tag payload

PRIVATE - Download a fiddle to zip
/Fiddles/:fiddleid/download
Returns URL to S3 bucket or some kind of file upload? Would this be fast enough?

PRIVATE - Screenshot a fiddle
/Fiddles/:fiddleid/screenshot
Integrate with carbon.now.sh and return an image

PRIVATE - Get code-blocks screenshot
/Fiddles/:fiddleid/code-blocks
Return the code blocks image for a fiddle

from api.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.