Code Monkey home page Code Monkey logo

openresty-api-example's Introduction

OpenResty API example

OpenResty allows Lua based scripting to create web applications directly on the Nginx webserver.

Your code is running inside the Nginx worker process and therefore does not need to be interpreted or compiled by another service; making it an efficient solution.

This is just a simple example of how you can expose an API endpoint using Nginx (api.conf) which passes the request to a Lua script (api.lua).

Examples

POST

curl --location --request POST 'localhost/api/test' \
--header 'Content-Type: application/json' \
--data-raw '{
	"example" : "true"
}'

Returns (json)

{"body":{"example":"true","keyData":{}}}

GET

curl --location --request GET 'localhost/api/test/1234/joeb' \
--header 'Content-Type: application/json' \
--data-raw '{
	"example" : "true"
}'

Returns (json)

{
    "body": {
        "example": "true",
        "keyData": {
            "name": "joeb",
            "id": "1234"
        }
    }
}

Notice

As far as I am aware Nginx does not provide a variable that outputs the relative path to its main conf file.

As a result, you need to set the absolute path to the lua file in content_by_lua_file

// ./api.conf
...
location ~ ^/api(.*)$ {
    default_type 'text/json';
    add_header 'Content-Type' 'application/json';

    ## NOTICE : change to this absolute path of lua file
    content_by_lua_file /ABS/PATH/TO/api.lua;
}
...

openresty-api-example's People

Contributors

forkbombe avatar iclukas avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

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.