https://github.com/jankapunkt/meteor-public-remote-api
A handy little class, which helps to expose public collections, methods and subscriptions into an api JSON file.
https://github.com/jankapunkt/meteor-public-remote-api
collections json meteor methods public publications
Last synced: 2 months ago
JSON representation
A handy little class, which helps to expose public collections, methods and subscriptions into an api JSON file.
- Host: GitHub
- URL: https://github.com/jankapunkt/meteor-public-remote-api
- Owner: jankapunkt
- License: mit
- Created: 2016-12-27T10:54:23.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-02-03T15:36:10.000Z (over 8 years ago)
- Last Synced: 2025-02-02T18:15:19.657Z (4 months ago)
- Topics: collections, json, meteor, methods, public, publications
- Language: JavaScript
- Size: 11.7 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Meteor Public API
Helps you to expose, what is public, while you code.
Just import the PublicApi class and add definitions directly when you define them.
## Usage
```javascript
import { PublicAPI } from "meteor/jkuester:public-api";
PublicAPI.setName("MY-MICROSERVICE-NAME");
PublicAPI.setDescription("describe what your application/microservice does...")
```
In your app you declare a method the usual way
```javascript
const MY_PUBLIC_METHOD = "my_public_method";
Meteor.methods(MY_PUBLIC_METHOD, function(){ /* some code */ });
```
And then expose it to the api:
```javascript
PublicAPI.addMethod(MY_PUBLIC_METHOD, "description of what your method does....");
```
Same with collections
```javascript
const MY_COLLECTION_NAME = "myCollectionName";
export MyCollection = new Mongo.Collection(MY_COLLECTION_NAME);
PublicAPI.addCollection(MY_COLLECTION_NAME, "a simple collection without schema");
```
And the same with publlications...
```javascript
const PUBCIC_DATA_FROM_MY_COLLECTION = "publicDataFromMyCollectio";
Meteor.publish(PUBCIC_DATA_FROM_MY_COLLECTION, function(){ /* some code */ });
PublicAPI.addPublication(PUBCIC_DATA_FROM_MY_COLLECTION, "tells my collection: show me what you got");
```
At the end of all your definitions, you call
```javascript
PublicAPI.publish("api.json", "path/to/public/", "subpath/in/public"/*, optionalCallback */);
```
And in your public folder will be something like this:
```javascript
{
"name": "public-api-test-package",
"desription": "some public description",
"urls": {
"default": "http://localhost:3000",
"fallback": "http://localhost:3333"
},
"methods": {
"get_all_methods": "a method which returns a list of all methods",
"some_call": "some other methods"
},
"publications": {
"get_all_docs": "gets all documents",
"get_other_docs": "gets som other documents"
},
"collections": {
"logs": "a log collection",
"dogs": "a dog collection"
}
}
```
## LICENCE
MIT, see licence file.