Giter VIP home page Giter VIP logo

documentdb-rest's Introduction

Copyright © 2015, Howard S. Edidin

DocumentDB-REST

Microsoft Azure's DocumentDB is a great PaaS NoSQL database. It supports Stored Procedures, User Defined Functions (UDF) and Triggers. A REST API is directly available, but a API Connector is not available. This project started off as an API Connector.

I started off trying to duplicate all the DocumentDB published REST API in Swagger. I used SwaggerHub to author the Swagger JSON file. I then using the Add REST API function in VS 2015 to generate the code for my API Application.

Source code

Working

The flowing operations are currently working:

  • Get an Offer
  • List Offers
  • Replace an Offer
  • Querying Offers
  • Create a Database
  • Get a Database
  • List Databases
  • Delete a Database
  • Create a User
  • Get a User
  • List Users
  • Delete a User
  • Create a Permission
  • Get a Permission
  • List Permissions
  • Replace a Permission
  • Delete a Permission
  • Create a Document
  • Get a Document
  • List Documents
  • Replace a Document
  • Delete a Document
  • Create an Attachment
  • Get an attachment
  • Create a Collection
  • Get a Collection
  • List Collections
  • Delete a Collection
  • Register a Stored Procedure
  • Execute a stored procedure
  • Query a UDF
  • Query a Trigger

Unimplemented

  • Auto generation of the Authorization Header to populate the header parameter
  • Create a trigger
  • Replace a trigger
  • Delete a trigger
  • List triggers
  • Create a UDF
  • Replace a UDF
  • Delete a UDF
  • Replace an attachment
  • List attachments
  • Delete attachments
  • Replace a stored procedure
  • List stored procedures
  • Delete a stored procedure
  • Query stored procedures
  • Enumeration of stored procedures to select from for Execute a stored procedure. This should be a drop down list on the API Docs
  • Security for accessing the API

Configure Swagger

You will need to modify YourDocumentDBAccount.documents.azure.com:443 in the Swagger file Replace YourDocumentDBAccount with your DocumentDB Account Name

Usage

The VS 2015 Project was added. The project is an API App. The code has ben refactored using ReSharper. You will need to restore the packages.

The DocumentDBConnector.cs is the base class.

The DocumentDbAccount public property is required. This is the same value as YourDocumentDBAccount

Changelog

  • 1.0.0 - 2015-12-14 - Initial Release

Contributing to DocumentDB-REST

I am willing to accept pull requests that implement any any unimplemented functionality listed as "Unimplemented" above. I would also like to hear any feedback for people using it.

LICENSE

documentdb-rest's People

Contributors

hedidin avatar

Watchers

 avatar  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.