Skip to content

Commit

Permalink
Remove links to blogs on pointsource.com
Browse files Browse the repository at this point in the history
(it doesn't exist anymore)
  • Loading branch information
Sean Kennedy authored and Sean Kennedy committed Jan 7, 2020
1 parent 803f484 commit e9fa478
Showing 1 changed file with 2 additions and 10 deletions.
12 changes: 2 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,11 @@ BlueOak Server is a NodeJS framework for building RESTful APIs.
[![Build Status](https://travis-ci.org/BlueOakJS/blueoak-server.svg?branch=master)](https://travis-ci.org/BlueOakJS/blueoak-server)
[![npm version](https://img.shields.io/npm/v/blueoak-server.svg)](https://www.npmjs.com/package/blueoak-server)

BlueOak Server is _swagger-matic_, that is, it maximizes the value of your Swagger API by using it to drive runtime behavior.
BlueOak Server is _swagger-matic_, that is, it maximizes the value of your Swagger API (now OpenAPI, but really this supports only V2) by using it to drive runtime behavior.
BlueOak Server loads your Swagger API, connects the paths it defines to your implementation code, exposes that API to the network, and validates that every request is well-formed per that API.

Check out the documentation on our wiki: <https://github.com/BlueOakJS/blueoak-server/wiki>

Why'd we do it? (and tell me more about it) - check out the [announcement blog][blog1].
How can it benefit me and my projects? - check out this [experience report][blog2].

### Overview

BlueOak Server combines some of the best Node libraries into a single tool for building RESTful APIs. It uses Express under the covers, but adds many additional features:
Expand Down Expand Up @@ -138,8 +135,7 @@ exports.init = function(config) {

[Swagger](https://github.com/BlueOakJS/blueoak-server/wiki/Handlers#swagger) files in the _swagger_ directory are read during server startup and automatically wired up to handlers. Swagger files can be in either json or yaml formats.

We've really focused on making API development with Swagger and BlueOak Server to be excellent.
[Checkout our ideas on best practices][blog3].
We've really focused on making API development with Swagger and BlueOak Server to be excellent.

At a high-level, BlueOak Server's Swagger support provides the following:
* Automatic app routing from the API method to the function as defined in the Swagger
Expand Down Expand Up @@ -201,7 +197,3 @@ Read through the [docs](https://github.com/BlueOakJS/blueoak-server/wiki) and lo

When you're ready to try it out, start from the [template](https://github.com/BlueOakJS/blueoak-server-template).

<!-- links -->
[blog1]: http://www.pointsource.com/blog/blueoak-server-released-to-open-source-to-accelerate-nodejs-development?utm_campaign=blueoak&utm_medium=social&utm_source=github&utm_content=PointSource
[blog2]: http://www.pointsource.com/blog/nodejs-experience-report-building-a-custom-mobile-backend-with-blueoak-server?utm_campaign=blueoak&utm_medium=social&utm_source=github&utm_content=PointSource
[blog3]: http://www.pointsource.com/blog/3-best-practices-for-api-development-with-swagger?utm_campaign=blueoak&utm_medium=social&utm_source=github&utm_content=PointSource

0 comments on commit e9fa478

Please sign in to comment.