https://github.com/iamogbz/render-apib-html

🌐 Serverless rendering of api blueprint files as styled html
https://github.com/iamogbz/render-apib-html

apiblueprint blueprint html lambda

Last synced: 21 days ago
JSON representation

🌐 Serverless rendering of api blueprint files as styled html

• Host: GitHub
• URL: https://github.com/iamogbz/render-apib-html
• Owner: iamogbz
• License: unlicense
• Created: 2019-08-01T06:24:49.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-04-30T10:47:56.000Z (7 months ago)
• Last Synced: 2024-05-02T01:37:23.246Z (7 months ago)
• Topics: apiblueprint, blueprint, html, lambda
• Language: TypeScript
• Homepage:
• Size: 41.4 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Render APIB HTML

[![Dependabot badge](https://badgen.net/github/dependabot/iamogbz/render-apib-html/?icon=dependabot)](https://app.dependabot.com)

[![Dependencies](https://img.shields.io/librariesio/github/iamogbz/render-apib-html)](https://github.com/iamogbz/render-apib-html)

[![Build Status](https://github.com/iamogbz/render-apib-html/workflows/Build/badge.svg)](https://github.com/iamogbz/render-apib-html/actions)

[![Coverage Status](https://coveralls.io/repos/github/iamogbz/render-apib-html/badge.svg?branch=master)](https://coveralls.io/github/iamogbz/render-apib-html?branch=master)

Serverless rendering of api blueprint files as styled html

## Usage

Make a request with the api blueprint base64 encoded in the `X-Blueprint` header.

### Endpoint

```http

https://d31myey2oeipxs.cloudfront.net

```

### Headers

```json

{

  "X-Blueprint": "IyBIZWxsbyBXb3JsZCE="

}

```

### Response

```html

Hello World!

```


### Example

```sh

curl --request GET \

  --location 'https://d31myey2oeipxs.cloudfront.net/v1' \

  --header 'X-Blueprint: Rk9STUFUOiAxQQoKIyBIZWxsbyBXb3JsZA=='

```

### Credits

- [Snowboard](//github.com/bukalapak/snowboard)

- [Aglio](//github.com/danielgtaylor/aglio) *needs maintenance*