GithubHelp home page GithubHelp logo

theweaver786 / rayso-api Goto Github PK

View Code? Open in Web Editor NEW

This project forked from akashrchandran/rayso-api

0.0 0.0 0.0 57 KB

Provides ray.so as a REST API version. Make beautiful and prettified code screenshots by just sending a POST or GET request.

Home Page: https://rayso.herokuapp.com/api

License: GNU General Public License v3.0

JavaScript 98.83% Procfile 1.17%

rayso-api's Introduction

Rayso-API

forthebadge

Provides ray.so as a REST API version. Make beautiful and prettified code screenshots by just sending a POST or GET request.

https://rayso.herokuapp.com/api

Parameters

Parameter Default value Type Description
code None (required) String The code which is used to make the screenshot.
title "Untitled-1" String The title will be displayed on top of the code box.
theme "breeze" String There are several options of how your box will look like. Available themes: breeze, candy, crimson, falcon, meadow, midnight, raindrop, sunset
background true Boolean If disabled, it will create an image of code box only, without background.
darkMode true Boolean If disabled, it will change your theme to its light version.
padding 32 String or Number Distance between borders and code box. Available values: 16, 32, 64 and 128.
language "auto" String You better leave it auto :/ However, you can try to pass some language name and if it worked, good for you!

Using GET Request /

It uses query parameters.

https://rayso.herokuapp.com/api?code=console.log(%22Hello%20World%22)%3B&language=javascript&title=Test

Using POST Request /

Body is JSON with these params:

{
    "code": "console.log('Hello World');",
    "language": "javascript",
    "title": "Test"
}

Example output

api

Credits

s0ftik3 -> For creating rayso-api package.

Me -> For nothing.

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.